User Want to Play Games 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.
On-site Representation
The user's Want to Play Games list page looks like:
HTTP Request
GET
https://retroachievements.org/API/API_GetUserWantToPlayList.php?u=MaxMilyin
Query Parameters
| Name | Required? | Description |
|---|---|---|
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
Kotlin
val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api
val response: NetworkResponse<GetUserWantToPlayList.Response, ErrorResponse> = api.getUserWantToPlayList(
username = "MaxMilyin",
)
if (response is NetworkResponse.Success) {
// handle the data
val wantToPlayList: GetUserWantToPlayList.Response = response.body
} else if (response is NetworkResponse.Error) {
// if the server returns an error it be found here
val errorResponse: ErrorResponse? = response.body
// if the api (locally) had an internal error, it'll be found here
val internalError: Throwable? = response.error
}Response
json
{
"Count": 100,
"Total": 1287,
"Results": [
{
"ID": 20246,
"Title": "~Hack~ Knuckles the Echidna in Sonic the Hedgehog",
"ImageIcon": "/Images/074560.png",
"ConsoleID": 1,
"ConsoleName": "Genesis/Mega Drive",
"PointsTotal": 1500,
"AchievementsPublished": 50
}
// ...
]
}