get_leaderboard: Retrieve the leaderboard of a segment

View source: R/get_leaderboard.R

get_leaderboardR Documentation

Retrieve the leaderboard of a segment

Description

Retrieve the leaderboard of a segment

Usage

get_leaderboard(stoken, id, nleaders = 10, All = FALSE)

Arguments

stoken

A config object created using the strava_oauth function

id

character for id of the segment

nleaders

numeric for number of leaders to retrieve

All

logical to retrieve all of the list

Details

Requires authentication stoken using the strava_oauth function and a user-created API on the strava website.

Value

Data from an API request.

Examples

## Not run: 
# create authentication token
# requires user created app name, id, and secret from Strava website
stoken <- httr::config(token = strava_oauth(app_name, app_client_id, 
	app_secret, cache = TRUE))

get_leaderboard(stoken, id = '229781')

## End(Not run)

rStrava documentation built on Oct. 23, 2024, 5:06 p.m.