v1

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

Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.

get/games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}

Path parameters

playerIdstring required

A player ID. A value of me may be used in place of the authenticated player's ID.

leaderboardIdstring required

The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.

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

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

Query parameters

includeRankType'ALL' | 'PUBLIC' | 'SOCIAL' | 'FRIENDS'

The types of ranks to return. If the parameter is omitted, no ranks will be returned.

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.

Response

Successful response