-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding docs for API_GetGameLeaderboards (#54)
- Loading branch information
Showing
3 changed files
with
72 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<script setup> | ||
import SampleRequest from '../components/SampleRequest.vue'; | ||
</script> | ||
|
||
# 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 | ||
|
||
<SampleRequest httpVerb="GET">https://retroachievements.org/API/API_GetGameLeaderboards.php?i=1</SampleRequest> | ||
|
||
### 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 | |