Table of Contents

Interface IAthletesApi

Namespace
Tudormobile.Strava.Api
Assembly
Tudormobile.Strava.dll

Strava V3 Athletes API Interface.

public interface IAthletesApi : IStravaApi
Inherited Members

Methods

GetLoggedInAthleteZonesAsync(CancellationToken)

Returns the authenticated athlete's heart rate and power zones. Requires profile:read_all.

Task<ApiResult<List<PowerZoneRanges>>> GetLoggedInAthleteZonesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests. The default value is None.

Returns

Task<ApiResult<List<PowerZoneRanges>>>

Collection of the athlete's heart rate and power zones.

GetStatsAsync(long, CancellationToken)

Returns the activity stats of an athlete. Only includes data from activities set to Everyone visibility.

Task<ApiResult<ActivityStats>> GetStatsAsync(long athleteId, CancellationToken cancellationToken = default)

Parameters

athleteId long

The identifier of the athlete. Must match the authenticated athlete.

cancellationToken CancellationToken

A token to monitor for cancellation requests. The default value is None.

Returns

Task<ApiResult<ActivityStats>>

The athlete's statistics.

ListAthleteClubsAsync(int?, int?, CancellationToken)

Returns a list of clubs the authenticated athlete is a member of.

Task<ApiResult<List<SummaryClub>>> ListAthleteClubsAsync(int? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

page int?

Page number. Defaults to null.

perPage int?

Number of items per page. Defaults to null.

cancellationToken CancellationToken

A token to monitor for cancellation requests. The default value is None.

Returns

Task<ApiResult<List<SummaryClub>>>

A collection of SummaryClub objects representing the athlete's clubs.

UpdateLoggedInAthleteAsync(double, CancellationToken)

Update the weight of the currently authenticated athlete. Requires profile:write scope.

Task<ApiResult<DetailedAthlete>> UpdateLoggedInAthleteAsync(double weight, CancellationToken cancellationToken = default)

Parameters

weight double

The weight of the athlete in kilograms.

cancellationToken CancellationToken

A token to monitor for cancellation requests. The default value is None.

Returns

Task<ApiResult<DetailedAthlete>>

The updated athlete details.