User Awards / Badges
A call to this endpoint will retrieve metadata about the target user's site awards, via their username.
On-site Representation
The easiest place to see a summary of user awards in the Progression Status component on the user profile:
HTTP Request
GET
https://retroachievements.org/API/API_GetUserAwards.php?u=MaxMilyin
Query Parameters
| Name | Required? | Description |
|---|---|---|
y | Yes | Your web API key. |
u | Yes | The target username. |
Client Library
ts
import { buildAuthorization, getUserAwards } 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 userAwards = await getUserAwards(authorization, { username: "xelnia" });kotlin
val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api
val response: NetworkResponse<GetUserAwards.Response, ErrorResponse> = api.getUserAwards(
username = "xelnia",
)
if (response is NetworkResponse.Success) {
// handle the data
val awards: GetUserAwards.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
Possible AwardType values are "Mastery/Completion", "Achievement Unlocks Yield", "Achievement Points Yield", "Patreon Supporter", "Certified Legend", and "Game Beaten".
json
{
"TotalAwardsCount": 1613,
"HiddenAwardsCount": 0,
"MasteryAwardsCount": 805,
"CompletionAwardsCount": 0,
"BeatenHardcoreAwardsCount": 807,
"BeatenSoftcoreAwardsCount": 0,
"EventAwardsCount": 2,
"SiteAwardsCount": 0,
"VisibleUserAwards": [
{
"AwardedAt": "2016-01-02T05:53:52+00:00",
"AwardType": "Game Beaten",
"AwardData": 1448,
"AwardDataExtra": 1, // 1 for hardcore mode, 0 for softcore mode
"DisplayOrder": 0,
"Title": "Mega Man",
"ConsoleID": 7,
"ConsoleName": "NES",
"Flags": 0,
"ImageIcon": "/Images/024519.png"
}
]
}json
{
"totalAwardsCount": 10,
"hiddenAwardsCount": 2,
"masteryAwardsCount": 6,
"completionAwardsCount": 0,
"beatenHardcoreAwardsCount": 24,
"beatenSoftcoreAwardsCount": 7,
"eventAwardsCount": 0,
"siteAwardsCount": 2,
"visibleUserAwards": [
{
"awardedAt": "2022-08-26T19:34:43+00:00",
"awardType": "Mastery/Completion",
"awardData": 802,
"awardDataExtra": 1,
"displayOrder": 114,
"title": "WarioWare, Inc.: Mega Microgames!",
"consoleName": "Game Boy Advance",
"flags": null,
"imageIcon": "/Images/034678.png"
}
// ...
]
}