Client

The Client object class for interacting with the Strava v3 API. While you can create this object without an access token, you will likely want to create an access token to authenticate and access most of the Strava data accessible via the API.

Constructor

Client([access_token, rate_limit_requests, ...])

Main client class for interacting with the exposed Strava v3 API methods.

General methods and attributes

Client.authorization_url(client_id, redirect_uri)	Get the URL needed to authorize your application to access a Strava user's information.
Client.exchange_code_for_token(client_id, ...)	Exchange the temporary authorization code (returned with redirect from strava authorization URL) for a short-lived access token and a refresh token (used to obtain the next access token later on).
Client.refresh_access_token(client_id, ...)	Exchanges the previous refresh token for a short-lived access token and a new refresh token (used to obtain the next access token later on).
Client.deauthorize()	Deauthorize the application.

Athlete methods

Client.get_activities([before, after, limit])	Get activities for authenticated user sorted by newest first.
Client.get_athlete([athlete_id])	Gets the specified athlete; if athlete_id is None then retrieves a detail-level representation of currently authenticated athlete; otherwise summary-level representation returned of athlete.
Client.get_athlete_friends([athlete_id, limit])	Gets friends for current (or specified) athlete.
Client.update_athlete([city, state, ...])	Updates the properties of the authorized athlete.
Client.get_athlete_followers([athlete_id, limit])	Gets followers for current (or specified) athlete.
Client.get_both_following(athlete_id[, limit])	Retrieve the athletes who both the authenticated user and the indicated
Client.get_athlete_koms(athlete_id[, limit])	Gets Q/KOMs/CRs for specified athlete.
Client.get_athlete_stats([athlete_id])	Returns Statistics for the athlete.
Client.get_athlete_clubs()	List the clubs for the currently authenticated athlete.
Client.get_gear(gear_id)	Get details for an item of gear.

Club related methods

Client.join_club(club_id)	Joins the club on behalf of authenticated athlete.
Client.leave_club(club_id)	Leave club on behalf of authenticated user.
Client.get_club(club_id)	Return a specific club object.
Client.get_club_members(club_id[, limit])	Gets the member objects for specified club ID.
Client.get_club_activities(club_id[, limit])	Gets the activities associated with specified club.

Activity related methods

Client.get_activity(activity_id[, ...])	Gets specified activity.
Client.get_friend_activities([limit])	DEPRECATED This endpoint was removed by Strava in Jan 2018.
Client.create_activity(name, activity_type, ...)	Create a new manual activity.
Client.update_activity(activity_id[, name, ...])	Updates the properties of a specific activity.
Client.upload_activity(activity_file, data_type)	Uploads a GPS file (tcx, gpx) to create a new activity for current athlete.
Client.delete_activity(activity_id)	Deletes the specified activity.
Client.get_activity_zones(activity_id)	Gets zones for activity.
Client.get_activity_comments(activity_id[, ...])	Gets the comments for an activity.
Client.get_activity_kudos(activity_id[, limit])	Gets the kudos for an activity.
Client.get_activity_photos(activity_id[, ...])	Gets the photos from an activity.
Client.get_activity_laps(activity_id)	Gets the laps from an activity.
Client.get_related_activities(activity_id[, ...])	Deprecated.

Segment related methods

Client.get_segment_effort(effort_id)	Return a specific segment effort by ID.
Client.get_segment(segment_id)	Gets a specific segment by ID.
Client.get_starred_segments([limit])	Returns a summary representation of the segments starred by the
Client.get_athlete_starred_segments(athlete_id)	Returns a summary representation of the segments starred by the
Client.get_segment_leaderboard(segment_id[, ...])	Gets the leaderboard for a segment.
Client.get_segment_efforts(segment_id[, ...])	Gets all efforts on a particular segment sorted by start_date_local
Client.explore_segments(bounds[, ...])	Returns an array of up to 10 segments.

Stream related methods

Client.get_activity_streams(activity_id[, ...])	Returns a stream for an activity.
Client.get_effort_streams(effort_id[, ...])	Returns an streams for an effort.
Client.get_segment_streams(segment_id[, ...])	Returns an streams for a segment.
Client.get_running_race(race_id)	Gets a running race for a given identifier.
Client.get_running_races([year])	Gets a running races for a given year.

Route related methods

Client.get_routes([athlete_id, limit])	Gets the routes list for an authenticated user.
Client.get_route(route_id)	Gets specified route.
Client.get_route_streams(route_id)	Returns streams for a route.

Subscription related methods

Client.create_subscription(client_id, ...[, ...])	Creates a webhook event subscription.
Client.handle_subscription_callback(raw[, ...])	Validate callback request and return valid response with challenge.
Client.handle_subscription_update(raw)	Converts a raw subscription update into a model.
Client.list_subscriptions(client_id, ...)	List current webhook event subscriptions in place for the current application.
Client.delete_subscription(subscription_id, ...)	Unsubscribe from webhook events for an existing subscription.

Activity Uploader Constructor

ActivityUploader(client, response[, raise_exc])

The "future" object that holds information about an activity file upload and can wait for upload to finish, etc.

ActivityUploader methods

ActivityUploader.update_from_response(response)

Updates internal state of object.

previous

API Reference

next

stravalib.client.Client