Skip to content

RoutesApi.md

Latest commit

 

History

History
134 lines (83 loc) · 4.25 KB

RoutesApi.md

File metadata and controls

134 lines (83 loc) · 4.25 KB

\RoutesApi

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

Method HTTP request Description
GetRouteAsGPX Get /routes/{id}/export_gpx Export Route GPX
GetRouteAsTCX Get /routes/{id}/export_tcx Export Route TCX
GetRouteById Get /routes/{id} Get Route
GetRoutesByAthleteId Get /athletes/{id}/routes List Athlete Routes

GetRouteAsGPX

GetRouteAsGPX(ctx, id) Export Route GPX

Returns a GPX file of the route. 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 int32 The identifier of the route.

Return type

(empty response body)

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]

GetRouteAsTCX

GetRouteAsTCX(ctx, id) Export Route TCX

Returns a TCX file of the route. 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 int32 The identifier of the route.

Return type

(empty response body)

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]

GetRouteById

Route GetRouteById(ctx, id) Get Route

Returns a route using its identifier. 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 int32 The identifier of the route.

Return type

Route

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]

GetRoutesByAthleteId

[]Route GetRoutesByAthleteId(ctx, id, optional) List Athlete Routes

Returns a list of the routes created by the authenticated athlete using their athlete ID. Private routes are filtered out unless requested by a token with read_all scope.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 The identifier of the athlete.
optional *GetRoutesByAthleteIdOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetRoutesByAthleteIdOpts struct

Name Type Description Notes

page | optional.Int32| Page number. | perPage | optional.Int32| Number of items per page. Defaults to 30. | [default to 30]

Return type

[]Route

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]