API Reference

Welcome to the API documentation for the stravalib package. Below the main modules are listed.

Warning

Only public facing methods are documented here.

• Client
  • Main Classes
  • General methods and attributes
  • Athlete methods
  • Club related methods
  • Activity related methods
  • Segment related methods
  • Stream related methods
  • Route related methods
  • Subscription related methods
  • Activity Uploader Constructor
  • ActivityUploader methods
• Model
  • Athletes
  • Activities
  • Activity Photos
  • Clubs
  • Routes and Segments
  • Segment Efforts
  • Webhook Subscriptions
  • Custom Types
  • Stravalib helpers
• Strava Model
  • ActivityStats
  • ActivityTotal
  • ActivityType
  • ActivityZone
  • AltitudeStream
  • BaseStream
  • CadenceStream
  • ClubActivity
  • ClubAnnouncement
  • ClubAthlete
  • Comment
  • DetailedActivity
  • DetailedAthlete
  • DetailedClub
  • DetailedGear
  • DetailedSegment
  • DetailedSegmentEffort
  • DistanceStream
  • Error
  • ExplorerResponse
  • ExplorerSegment
  • Fault
  • HeartRateZoneRanges
  • HeartrateStream
  • Lap
  • LatLng
  • LatLngStream
  • MembershipApplication
  • MetaActivity
  • MetaAthlete
  • MetaClub
  • MovingStream
  • PhotosSummary
  • PolylineMap
  • PowerStream
  • PowerZoneRanges
  • Primary
  • Route
  • SmoothGradeStream
  • SmoothVelocityStream
  • Split
  • SportType
  • StreamSet
  • StreamType
  • SummaryActivity
  • SummaryAthlete
  • SummaryClub
  • SummaryGear
  • SummaryPRSegmentEffort
  • SummarySegment
  • SummarySegmentEffort
  • TemperatureStream
  • TimeStream
  • TimedZoneDistribution
  • TimedZoneRange
  • UpdatableActivity
  • Upload
  • Waypoint
  • ZoneRange
  • ZoneRanges
  • Zones
• Unit helper
  • Summary Functions
  • Summary Classes
• Protocol
  • Protocol
  • AccessInfo
  • ApiV3
• Limiter (Util Submodule)
  • Summary Functions
  • Summary Classes
• Exceptions & Error Handling
• AccessUnauthorized
  • AccessUnauthorized.add_note()
  • AccessUnauthorized.args
  • AccessUnauthorized.characters_written
  • AccessUnauthorized.errno
  • AccessUnauthorized.filename
  • AccessUnauthorized.filename2
  • AccessUnauthorized.request
  • AccessUnauthorized.response
  • AccessUnauthorized.strerror
  • AccessUnauthorized.with_traceback()
• ActivityPhotoUploadFailed
  • ActivityPhotoUploadFailed.add_note()
  • ActivityPhotoUploadFailed.args
  • ActivityPhotoUploadFailed.with_traceback()
• ActivityPhotoUploadNotSupported
  • ActivityPhotoUploadNotSupported.add_note()
  • ActivityPhotoUploadNotSupported.args
  • ActivityPhotoUploadNotSupported.with_traceback()
• ActivityUploadFailed
  • ActivityUploadFailed.add_note()
  • ActivityUploadFailed.args
  • ActivityUploadFailed.with_traceback()
• ApplicationInactive
  • ApplicationInactive.add_note()
  • ApplicationInactive.args
  • ApplicationInactive.characters_written
  • ApplicationInactive.errno
  • ApplicationInactive.filename
  • ApplicationInactive.filename2
  • ApplicationInactive.request
  • ApplicationInactive.response
  • ApplicationInactive.strerror
  • ApplicationInactive.with_traceback()
• AuthError
  • AuthError.add_note()
  • AuthError.args
  • AuthError.with_traceback()
• CreatedActivityDeleted
  • CreatedActivityDeleted.add_note()
  • CreatedActivityDeleted.args
  • CreatedActivityDeleted.with_traceback()
• ErrorProcessingActivity
  • ErrorProcessingActivity.add_note()
  • ErrorProcessingActivity.args
  • ErrorProcessingActivity.with_traceback()
• Fault
  • Fault.add_note()
  • Fault.args
  • Fault.characters_written
  • Fault.errno
  • Fault.filename
  • Fault.filename2
  • Fault.request
  • Fault.response
  • Fault.strerror
  • Fault.with_traceback()
• LoginFailed
  • LoginFailed.add_note()
  • LoginFailed.args
  • LoginFailed.with_traceback()
• LoginRequired
  • LoginRequired.add_note()
  • LoginRequired.args
  • LoginRequired.with_traceback()
• NotAuthenticatedAthlete
  • NotAuthenticatedAthlete.add_note()
  • NotAuthenticatedAthlete.args
  • NotAuthenticatedAthlete.with_traceback()
• ObjectNotFound
  • ObjectNotFound.add_note()
  • ObjectNotFound.args
  • ObjectNotFound.characters_written
  • ObjectNotFound.errno
  • ObjectNotFound.filename
  • ObjectNotFound.filename2
  • ObjectNotFound.request
  • ObjectNotFound.response
  • ObjectNotFound.strerror
  • ObjectNotFound.with_traceback()
• RateLimitExceeded
  • RateLimitExceeded.add_note()
  • RateLimitExceeded.args
  • RateLimitExceeded.with_traceback()
• RateLimitTimeout
  • RateLimitTimeout.add_note()
  • RateLimitTimeout.args
  • RateLimitTimeout.with_traceback()
• TimeoutExceeded
  • TimeoutExceeded.add_note()
  • TimeoutExceeded.args
  • TimeoutExceeded.with_traceback()
• UnboundEntity
  • UnboundEntity.add_note()
  • UnboundEntity.args
  • UnboundEntity.with_traceback()
• warn_attribute_unofficial()
• warn_method_deprecation()
• warn_method_restricted()
• warn_method_unofficial()
• warn_param_deprecation()
• warn_param_unofficial()
• warn_param_unsupported()
• warn_units_deprecated()

Module Details