Skip to content

Latest commit

 

History

History
179 lines (127 loc) · 5.58 KB

StreamsApi.md

File metadata and controls

179 lines (127 loc) · 5.58 KB
Raw

strava_api_v3.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_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

StreamSet get_activity_streams(id, keys, key_by_type)

Get Activity Streams

Returns the given activity's streams.

Example

from __future__ import print_function
import time
import strava_api_v3
from strava_api_v3.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: strava_oauth
configuration = strava_api_v3.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = strava_api_v3.StreamsApi(strava_api_v3.ApiClient(configuration))
id = 789 # int | The identifier of the activity.
keys = ['keys_example'] # list[str] | Desired stream types.
key_by_type = true # bool | Must be true. (default to true)

try:
    # Get Activity Streams
    api_response = api_instance.get_activity_streams(id, keys, key_by_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsApi->get_activity_streams: %s\n" % e)

Parameters

Name Type Description Notes
id int The identifier of the activity.
keys list[str] Desired stream types.
key_by_type 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]

get_segment_effort_streams

StreamSet get_segment_effort_streams(id, keys, key_by_type)

Get segment effort streams

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

Example

from __future__ import print_function
import time
import strava_api_v3
from strava_api_v3.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: strava_oauth
configuration = strava_api_v3.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = strava_api_v3.StreamsApi(strava_api_v3.ApiClient(configuration))
id = 789 # int | The identifier of the segment effort.
keys = ['keys_example'] # list[str] | The types of streams to return.
key_by_type = true # bool | Must be true. (default to true)

try:
    # Get segment effort streams
    api_response = api_instance.get_segment_effort_streams(id, keys, key_by_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsApi->get_segment_effort_streams: %s\n" % e)

Parameters

Name Type Description Notes
id int The identifier of the segment effort.
keys list[str] The types of streams to return.
key_by_type 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]

get_segment_streams

StreamSet get_segment_streams(id, keys, key_by_type)

Get Segment Streams

Returns the given segment's streams.

Example

from __future__ import print_function
import time
import strava_api_v3
from strava_api_v3.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: strava_oauth
configuration = strava_api_v3.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = strava_api_v3.StreamsApi(strava_api_v3.ApiClient(configuration))
id = 789 # int | The identifier of the segment.
keys = ['keys_example'] # list[str] | The types of streams to return.
key_by_type = true # bool | Must be true. (default to true)

try:
    # Get Segment Streams
    api_response = api_instance.get_segment_streams(id, keys, key_by_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsApi->get_segment_streams: %s\n" % e)

Parameters

Name Type Description Notes
id int The identifier of the segment.
keys list[str] The types of streams to return.
key_by_type 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]