Skip to content

Latest commit

 

History

History
141 lines (91 loc) · 5.23 KB

SegmentsApi.md

File metadata and controls

141 lines (91 loc) · 5.23 KB
Raw

{{classname}}

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

Method HTTP request Description
ExploreSegments Get /segments/explore Explore segments
GetLoggedInAthleteStarredSegments Get /segments/starred List Starred Segments
GetSegmentById Get /segments/{id} Get Segment
StarSegment Put /segments/{id}/starred Star Segment

ExploreSegments

ExplorerResponse ExploreSegments(ctx, bounds, optional) Explore segments

Returns the top 10 segments matching a specified query.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bounds []float32 The latitude and longitude for two points describing a rectangular boundary for the search: [southwest corner latitutde, southwest corner longitude, northeast corner latitude, northeast corner longitude]
optional *SegmentsApiExploreSegmentsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SegmentsApiExploreSegmentsOpts struct

Name Type Description Notes

activityType | optional.String| Desired activity type. | minCat | optional.Int32| The minimum climbing category. | maxCat | optional.Int32| The maximum climbing category. |

Return type

ExplorerResponse

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]

GetLoggedInAthleteStarredSegments

[]SummarySegment GetLoggedInAthleteStarredSegments(ctx, optional) List Starred Segments

List of the authenticated athlete's starred segments. Private segments 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.
optional *SegmentsApiGetLoggedInAthleteStarredSegmentsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SegmentsApiGetLoggedInAthleteStarredSegmentsOpts struct

Name Type Description Notes
page optional.Int32 Page number. Defaults to 1.
perPage optional.Int32 Number of items per page. Defaults to 30. [default to 30]

Return type

[]SummarySegment

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]

GetSegmentById

DetailedSegment GetSegmentById(ctx, id) Get Segment

Returns the specified segment. read_all scope required in order to retrieve athlete-specific segment information, or to retrieve 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.

Return type

DetailedSegment

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]

StarSegment

DetailedSegment StarSegment(ctx, starred, id) Star Segment

Stars/Unstars the given segment for the authenticated athlete. Requires profile:write scope.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
starred bool
id int64 The identifier of the segment to star.

Return type

DetailedSegment

Authorization

strava_oauth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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