Inactive Claims
A call to this endpoint returns information about all (1000 max) achievement set development claims of a specified kind: completed, dropped, or expired.
HTTP Request
GET
https://retroachievements.org/API/API_GetClaims.php?k=1
Query Parameters
| Name | Required? | Description |
|---|---|---|
y | Yes | Your web API key. |
k | The desired claim kind: 1 (completed), 2 (dropped), or 3 (expired). Defaults to 1. |
Client Library
ts
import { buildAuthorization, getClaims } from "@retroachievements/api";
// First, build your authorization object.
const username = "<your username on RA>";
const webApiKey = "<your web API key>";
const authorization = buildAuthorization({ username, webApiKey });
// Then, make the API call.
const claims = await getClaims(authorization, { claimKind: "completed" });kotlin
val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api
val response: NetworkResponse<GetClaims.Response, ErrorResponse> = api.getClaims(
claimKind = 2
)
if (response is NetworkResponse.Success) {
// handle the data
val claims: GetClaims.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
[
{
"ID": 11245,
"User": "kmpers",
"GameID": 24541,
"GameTitle": "GP World",
"GameIcon": "/Images/076324.png",
"ConsoleID": 33,
"ConsoleName": "SG-1000",
"ClaimType": 0,
"SetType": 1,
"Status": 1,
"Extension": 0,
"Special": 1,
"Created": "2023-10-27 22:30:49",
"DoneTime": "2023-10-27 23:21:12",
"Updated": "2023-10-27 23:21:12",
"UserIsJrDev": 0,
"MinutesLeft": -173762
}
// ...
]json
[
{
"id": 11245,
"user": "kmpers",
"gameId": 24541,
"gameTitle": "GP World",
"gameIcon": "/Images/076324.png",
"consoleId": 33,
"consoleName": "SG-1000",
"claimType": 0,
"setType": 1,
"status": 1,
"extension": 0,
"special": 1,
"created": "2023-10-27 22:30:49",
"doneTime": "2023-10-27 23:21:12",
"updated": "2023-10-27 23:21:12",
"userIsJrDev": false,
"minutesLeft": -173762
}
// ...
]