RoutesApi
All URIs are relative to https://www.strava.com/api/v3
| Method | HTTP request | Description |
|---|---|---|
| getrouteasgp_x | GET /routes/{id}/export_gpx | Export Route GPX |
| getrouteastc_x | GET /routes/{id}/export_tcx | Export Route TCX |
| getrouteby_id | GET /routes/{id} | Get Route |
| getroutesbyathleteid | GET /athletes/{id}/routes | List Athlete Routes |
getrouteasgp_x
getrouteasgpx(api::RoutesApi, id::Int64; mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/> getrouteasgpx(api::RoutesApi, responsestream::Channel, id::Int64; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
Export Route GPX
Returns a GPX file of the route. Requires read_all scope for private routes.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | RoutesApi | API context | |
| id | Int64 | The identifier of the route. |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getrouteastc_x
getrouteastcx(api::RoutesApi, id::Int64; mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/> getrouteastcx(api::RoutesApi, responsestream::Channel, id::Int64; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
Export Route TCX
Returns a TCX file of the route. Requires read_all scope for private routes.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | RoutesApi | API context | |
| id | Int64 | The identifier of the route. |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getrouteby_id
getroutebyid(api::RoutesApi, id::Int64; mediaType=nothing) -> Route, OpenAPI.Clients.ApiResponse <br/> getroutebyid(api::RoutesApi, responsestream::Channel, id::Int64; _mediaType=nothing) -> Channel{ Route }, OpenAPI.Clients.ApiResponse
Get Route
Returns a route using its identifier. Requires read_all scope for private routes.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | RoutesApi | API context | |
| id | Int64 | The identifier of the route. |
Return type
Authorization
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
getroutesbyathleteid(api::RoutesApi; page=nothing, perpage=nothing, mediaType=nothing) -> Vector{Route}, OpenAPI.Clients.ApiResponse <br/> getroutesbyathleteid(api::RoutesApi, responsestream::Channel; page=nothing, perpage=nothing, _mediaType=nothing) -> Channel{ Vector{Route} }, OpenAPI.Clients.ApiResponse
List Athlete Routes
Returns a list of the routes created by the authenticated athlete. Private routes are filtered out unless requested by a token with read_all scope.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | RoutesApi | API context |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Int64 | Page number. Defaults to 1. | [default to nothing] |
| per_page | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]