v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-133977107.4 KB
scores

Lists the scores in a leaderboard around (and including) a player's score.

get/games/v1/leaderboards/{leaderboardId}/window/{collection}

Path parameters

leaderboardIdstring required

The ID of the leaderboard.

collection'PUBLIC' | 'SOCIAL' | 'FRIENDS' required

The collection of scores you're requesting.

Query parameters

timeSpan'ALL_TIME' | 'WEEKLY' | 'DAILY' required

Required. The time span for the scores and ranks you're requesting.

languagestring

The preferred language to use for strings returned by this method.

maxResultsinteger

The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.

pageTokenstring

The token returned by the previous request.

resultsAboveinteger

The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.

returnTopIfAbsentboolean

True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.

Response

Successful response