stravalib.client.Client.get_starred_segments#
- Client.get_starred_segments(limit: int | None = None) BatchedResultsIterator[Segment] [source]#
- Returns a summary representation of the segments starred by the
authenticated user. Pagination is supported.
https://developers.strava.com/docs/reference/#api-Segments-getLoggedInAthleteStarredSegments
- Parameters:
limit (int, optional, default=None) – Limit number of starred segments returned.
- Returns:
class – An iterator of
stravalib.model.Segment
starred by authenticated user.- Return type:
BatchedResultsIterator