From 0a7930c2665f961f92492f02803b1a6fee08c44f Mon Sep 17 00:00:00 2001 From: Joshua Raphael Date: Mon, 18 Nov 2024 22:58:36 -0700 Subject: [PATCH 1/4] docs: fix GetUserWantToPlayList response and query parameters --- docs/v1/get-user-want-to-play-list.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/v1/get-user-want-to-play-list.md b/docs/v1/get-user-want-to-play-list.md index 331d623..a9d95f0 100644 --- a/docs/v1/get-user-want-to-play-list.md +++ b/docs/v1/get-user-want-to-play-list.md @@ -22,7 +22,6 @@ The user's Want to Play Games list page looks like: | Name | Required? | Description | | :--- | :-------- | :----------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `c` | | Count, number of records to return (default: 100, max: 500). | @@ -42,7 +41,7 @@ Not yet supported. "Total": 1287, "Results": [ { - "GameID": 20246, + "ID": 20246, "Title": "~Hack~ Knuckles the Echidna in Sonic the Hedgehog", "ImageIcon": "/Images/074560.png", "ConsoleID": 1, From 207eb73fd75fe5fad596133157576b001e80fd5c Mon Sep 17 00:00:00 2001 From: Joshua Raphael Date: Wed, 20 Nov 2024 02:31:42 -0700 Subject: [PATCH 2/4] fix get-game-rank-and-score query parameters --- docs/v1/get-game-rank-and-score.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/v1/get-game-rank-and-score.md b/docs/v1/get-game-rank-and-score.md index c4339d4..11da2a5 100644 --- a/docs/v1/get-game-rank-and-score.md +++ b/docs/v1/get-game-rank-and-score.md @@ -22,9 +22,8 @@ When browsing a game page, for example, [Sonic the Hedgehog](https://retroachiev | Name | Required? | Description | | :--- | :-------- | :----------------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | -| `i` | Yes | The target game ID. | +| `g` | Yes | The target game ID. | | `t` | | 1 for latest masters. 0 for non-master high scores. Defaults to 0. | ## Client Library From 90403f78149f94960970303d57c0c338819d05d7 Mon Sep 17 00:00:00 2001 From: Joshua Raphael Date: Fri, 22 Nov 2024 06:39:57 -0700 Subject: [PATCH 3/4] add missing leaderboard endpoints to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 4b1f783..d88a9a5 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,11 @@ Click the function names to open their complete docs on the docs site. - [Unlocks Distribution](https://api-docs.retroachievements.org/v1/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game. - [High Scores](https://api-docs.retroachievements.org/v1/get-game-rank-and-score.html) - Get a list of either the latest masters or highest hardcore points earners for a game. +### Leaderboards + +- [Leaderboards (by gameID)](https://api-docs.retroachievements.org/v1/get-game-leaderboards.html) - Get a given games's list of leaderboards. +- [Entries](https://api-docs.retroachievements.org/v1/get-leaderboard-entries.html) - Get a given leadboard's entires. + ### System - [Get All Systems](https://api-docs.retroachievements.org/v1/get-console-ids.html) - Get the complete list of system ID and name pairs on the site. From bcfa8089d871da5f26b7ad27836cb53a508e4ff1 Mon Sep 17 00:00:00 2001 From: Joshua Raphael Date: Fri, 22 Nov 2024 07:12:09 -0700 Subject: [PATCH 4/4] fix get-leaderboard-entries --- docs/v1/get-leaderboard-entries.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/v1/get-leaderboard-entries.md b/docs/v1/get-leaderboard-entries.md index ee80119..abf9c87 100644 --- a/docs/v1/get-leaderboard-entries.md +++ b/docs/v1/get-leaderboard-entries.md @@ -22,7 +22,6 @@ A leaderboards's entries can be found on the leaderboard info page: | Name | Required? | Description | | :--- | :-------- | :----------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `i` | Yes | The target leaderboard ID. | | `c` | | Count, number of records to return (default: 100, max: 500). | @@ -46,7 +45,7 @@ Not yet supported. "User": "vani11a", "Score": 390490, "FormattedScore": "390,490", - "DateSubmitted": "2024-07-25T15:51:00Z" + "DateSubmitted": "2024-07-25T15:51:00+00:00" } // ... ]