Game Leaderboards
A call to this endpoint will retrieve a given game's list of leaderboards, targeted by the game's ID.
On-site Representation
A game's list of leaderboards can be found on the game's page:
HTTP Request
GET
https://retroachievements.org/API/API_GetGameLeaderboards.php?i=1
Query Parameters
| Name | Required? | Description |
|---|---|---|
y | Yes | Your web API key. |
i | Yes | The target game ID. |
c | Count, number of records to return (default: 100, max: 500). | |
o | Offset, number of entries to skip (default: 0). |
Client Library
ts
import {
buildAuthorization,
getGameLeaderboards,
} from "@retroachievements/api";
// First, build your authorization object.
const username = "<your username on RA>";
const webApiKey = "<your web API key>";
const authorization = buildAuthorization({ username, webApiKey });
// Then, make the API call.
const gameLeaderboards = await getGameLeaderboards(authorization, {
gameId: 14402,
});Kotlin
val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api
val response: NetworkResponse<GetGameLeaderboards.Response, ErrorResponse> = api.getGameLeaderboards(
gameId = 14402
)
if (response is NetworkResponse.Success) {
// handle the data
val gameLeaderboards: GetGameLeaderboards.Response = response.body
} else if (response is NetworkResponse.Error) {
// if the server returns an error it be found here
val errorResponse: ErrorResponse? = response.body
// if the api (locally) had an internal error, it'll be found here
val internalError: Throwable? = response.error
}Response
json
{
"Count": 29,
"Total": 29,
"Results": [
{
"ID": 104370,
"RankAsc": false,
"Title": " South Island Conqueror",
"Description": "Complete the game with the highest score possible",
"Format": "VALUE",
"Author": "Scott",
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZA",
"TopEntry": {
"User": "vani11a",
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
"Score": "390490",
"FormattedScore": "390,490"
}
}
// ...
]
}json
{
"count": 29,
"total": 29,
"results": [
{
"id": 104370,
"rankAsc": false,
"title": " South Island Conqueror",
"description": "Complete the game with the highest score possible",
"format": "VALUE",
"author": "Scott",
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZA",
"state": "active",
"topEntry": {
"user": "vani11a",
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
"score": 390490,
"formattedScore": "390,490"
}
}
// ...
]
}