diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index b201dc1..879c62c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -139,9 +139,13 @@ export default defineConfig({ ], }, { - text: "Leaderboard", + text: "Leaderboards", collapsible: true, items: [ + { + text: "Leaderboards (by gameID)", + link: "/v1/get-game-leaderboards", + }, { text: "Entries", link: "/v1/get-leaderboard-entries", diff --git a/docs/public/game-leaderboards.png b/docs/public/game-leaderboards.png new file mode 100644 index 0000000..69b19ad Binary files /dev/null and b/docs/public/game-leaderboards.png differ diff --git a/docs/v1/get-game-leaderboards.md b/docs/v1/get-game-leaderboards.md new file mode 100644 index 0000000..81d5077 --- /dev/null +++ b/docs/v1/get-game-leaderboards.md @@ -0,0 +1,67 @@ + + +# Game Leaderboards + +A call to this endpoint will retrieve a given games's list of leaderboards, targeted by the game's ID. + +[[toc]] + +## On-site Representation + +A games's list of leaderboards can be found on on the game's page: + +![Game Leaderboards](/game-leaderboards.png) + +## HTTP Request + +https://retroachievements.org/API/API_GetGameLeaderboards.php?i=1 + +### Query Parameters + +| Name | Required? | Description | +| :--- | :-------- | :----------------------------------------------------------- | +| `z` | Yes | Your username. | +| `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 + +Not yet supported. + +## Response + +::: code-group + +```json [HTTP Response] +{ + "Count": 29, + "Total": 29, + "Results": [ + { + "ID": 104370, + "RankAsc": false, + "Title": " South Island Conqueror", + "Description": "Complete the game with the highest score possible", + "Format": "VALUE", + "TopEntry": { + "User": "vani11a", + "Score": "390490", + "FormattedScore": "390,490" + } + } + // ... + ] +} +``` + +::: + +## Source + +| Repo | URL | +| :---- | :-------------------------------------------------------------------------------------------- | +| RAWeb | https://github.com/RetroAchievements/RAWeb/blob/master/public/API/API_GetGameLeaderboards.php |