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.

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: add UserWantToPlayList endpoint #52

Merged
merged 23 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Click the function names to open their complete docs on the docs site.
- [Recently Played Games](https://api-docs.retroachievements.org/v1/get-user-recently-played-games.html) - Get a list of games a user has recently played.
- [Summary](https://api-docs.retroachievements.org/v1/get-user-summary.html) - Get a user's profile metadata.
- [Completed Games](https://api-docs.retroachievements.org/v1/get-user-completed-games.html) - Legacy endpoint. Get hardcore and softcore completion metadata about games a user has played.
- [Want to Play Games List](https://api-docs.retroachievements.org/v1/get-user-want-to-play-list.html) - Get a user's list of Want to Play Games.

### Game

Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ export default defineConfig({
text: "Completed Games",
link: "/v1/get-user-completed-games",
},
{
text: "Want to Play Games List",
link: "/v1/get-user-want-to-play-list",
},
],
},
{
Expand Down
Binary file added docs/public/want-to-play-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs/v1/get-user-want-to-play-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<script setup>
import SampleRequest from '../components/SampleRequest.vue';
</script>

# User Want to Play List

A call to this endpoint will retrieve a given user's "Want to Play Games" list, targeted by their username. Results will only be returned if the target user is yourself, or if both you and the target user follow each other.

[[toc]]

## On-site Representation

The user's Want to Play Games list page looks like:

![Want to Play Games List](/want-to-play-list.png)

## HTTP Request

<SampleRequest httpVerb="GET">https://retroachievements.org/API/API_GetUserWantToPlayList.php?u=MaxMilyin</SampleRequest>

### Query Parameters

| 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). |
| `o` | | Offset, number of entries to skip (default: 0). |

## Client Library

Not yet supported.

## Response

::: code-group

```json [HTTP Response]
{
"Count": 100,
"Total": 1287,
"Results": [
{
"GameID": 20246,
"Title": "~Hack~ Knuckles the Echidna in Sonic the Hedgehog",
"ImageIcon": "/Images/074560.png",
"ConsoleID": 1,
"ConsoleName": "Genesis/Mega Drive",
"PointsTotal": 1500,
"AchievementsPublished": 50
}
// ...
]
}
```

:::

## Source

| Repo | URL |
| :---- | :---------------------------------------------------------------------------------------------- |
| RAWeb | https://github.com/RetroAchievements/RAWeb/blob/master/public/API/API_GetUserWantToPlayList.php |