Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix GetUserWantToPlayList, GetGameRankAndScore, GetLeaderboardEntries, and README #63

Merged
merged 4 commits into from
Nov 22, 2024
Merged

docs: fix GetUserWantToPlayList, GetGameRankAndScore, GetLeaderboardEntries, and README #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0a7930c
docs: fix GetUserWantToPlayList response and query parameters
joshraphael Nov 19, 2024
207eb73
fix get-game-rank-and-score query parameters
joshraphael Nov 20, 2024
90403f7
add missing leaderboard endpoints to README
joshraphael Nov 22, 2024
bcfa808
fix get-leaderboard-entries
joshraphael Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions docs/v1/get-game-rank-and-score.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/v1/get-leaderboard-entries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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). |
Expand All @@ -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"
}
// ...
]
Expand Down
3 changes: 1 addition & 2 deletions docs/v1/get-user-want-to-play-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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). |
Expand All @@ -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,
Expand Down