Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 4.42 KB

StreamsApi.md

File metadata and controls

130 lines (82 loc) · 4.42 KB
Raw

\StreamsApi

All URIs are relative to https://www.strava.com/api/v3

Method HTTP request Description
GetActivityStreams Get /activities/{id}/streams Get Activity Streams
GetRouteStreams Get /routes/{id}/streams Get Route Streams
GetSegmentEffortStreams Get /segment_efforts/{id}/streams Get Segment Effort Streams
GetSegmentStreams Get /segments/{id}/streams Get Segment Streams

GetActivityStreams

StreamSet GetActivityStreams(ctx, id, keys, keyByType) Get Activity Streams

Returns the given activity's streams. Requires activity:read scope. Requires activity:read_all scope for Only Me activities.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 The identifier of the activity.
keys []string Desired stream types.
keyByType bool Must be true. [default to true]

Return type

StreamSet

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRouteStreams

StreamSet GetRouteStreams(ctx, id) Get Route Streams

Returns the given route's streams. Requires read_all scope for private routes.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 The identifier of the route.

Return type

StreamSet

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSegmentEffortStreams

StreamSet GetSegmentEffortStreams(ctx, id, keys, keyByType) Get Segment Effort Streams

Returns a set of streams for a segment effort completed by the authenticated athlete. Requires read_all scope.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 The identifier of the segment effort.
keys []string The types of streams to return.
keyByType bool Must be true. [default to true]

Return type

StreamSet

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSegmentStreams

StreamSet GetSegmentStreams(ctx, id, keys, keyByType) Get Segment Streams

Returns the given segment's streams. Requires read_all scope for private segments.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 The identifier of the segment.
keys []string The types of streams to return.
keyByType bool Must be true. [default to true]

Return type

StreamSet

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]