Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 4.52 KB

StreamsApi.md

File metadata and controls

130 lines (82 loc) · 4.52 KB

\StreamsApi

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

Method HTTP request Description
get_activity_streams Get /activities/{id}/streams Get Activity Streams
get_route_streams Get /routes/{id}/streams Get Route Streams
get_segment_effort_streams Get /segment_efforts/{id}/streams Get Segment Effort Streams
get_segment_streams Get /segments/{id}/streams Get Segment Streams

get_activity_streams

::models::StreamSet get_activity_streams(ctx, id, keys, key_by_type) 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 containing the authentication nil if no authentication
id i64 The identifier of the activity.
keys Vec<String> Desired stream types.
key_by_type bool Must be true. [default to true]

Return type

::models::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]

get_route_streams

::models::StreamSet get_route_streams(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 containing the authentication nil if no authentication
id i64 The identifier of the route.

Return type

::models::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]

get_segment_effort_streams

::models::StreamSet get_segment_effort_streams(ctx, id, keys, key_by_type) 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 containing the authentication nil if no authentication
id i64 The identifier of the segment effort.
keys Vec<String> The types of streams to return.
key_by_type bool Must be true. [default to true]

Return type

::models::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]

get_segment_streams

::models::StreamSet get_segment_streams(ctx, id, keys, key_by_type) 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 containing the authentication nil if no authentication
id i64 The identifier of the segment.
keys Vec<String> The types of streams to return.
key_by_type bool Must be true. [default to true]

Return type

::models::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]