User Set Requests

A call to this endpoint will retrieve a given user's set requests, maximum total requests and points until next request.

• On-Site Representation
• HTTP Request
  • Query Parameters
• Client Library
• Response
• Source

On-Site Representation

HTTP Request

GET

https://retroachievements.org/API/API_GetUserSetRequests.php?u=MaxMilyin

Query Parameters

You must query the user by either their username or their ULID. Please note the username is not considered a stable value. As of 2025, users can change their usernames. Initially querying by username is a good way to fetch a ULID.

Name	Required?	Description
y	Yes	Your web API key.
u		The target username or ULID.
t	No	Request List Type: 0 for active requests, 1 for all requests. Defaults to 0.

Client Library

NodeJS

import { buildAuthorization, getUserSetRequests } 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 userSetRequests = await getUserSetRequests(authorization, {
  username: "MaxMilyin",
});

// Note: the payload object can contain an additional property called
// `requestListType` to return a tailored list of set requests. To use
// this property, import `RequestListType` from `@retroachievements/api`
// to use the enums.

Kotlin

val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api

val response: NetworkResponse<GetUserSetRequests.Response, ErrorResponse> = api.getUserSetRequests(
     userId = "MaxMilyin"
)

if (response is NetworkResponse.Success) {
    // handle the data
    val userSetRequests: GetUserSetRequests.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

HTTP Response

{
  "RequestedSets": [
    {
      "GameID": 8149,
      "Title": "Jurassic Park Institute Tour: Dinosaur Rescue",
      "ConsoleID": 5,
      "ConsoleName": "Game Boy Advance",
      "ImageIcon": "/Images/000001.png"
    },
    {
      "GameID": 600,
      "Title": "Psycho Pinball",
      "ConsoleID": 1,
      "ConsoleName": "Genesis/Mega Drive",
      "ImageIcon": "/Images/039797.png"
    },
    {
      "GameID": 1,
      "Title": "Sonic the Hedgehog",
      "ConsoleID": 1,
      "ConsoleName": "Genesis/Mega Drive",
      "ImageIcon": "/Images/085573.png"
    }
  ],
  "TotalRequests": 5,
  "PointsForNext": 5000
}

NodeJS

{
  "requestedSets": [
    {
      "gameId": 8149,
      "title": "Jurassic Park Institute Tour: Dinosaur Rescue",
      "consoleId": 5,
      "consoleName": "Game Boy Advance",
      "imageIcon": "/Images/000001.png"
    },
    {
      "gameId": 600,
      "title": "Psycho Pinball",
      "consoleId": 1,
      "consoleName": "Genesis/Mega Drive",
      "imageIcon": "/Images/039797.png"
    },
    {
      "gameId": 1,
      "title": "Sonic the Hedgehog",
      "consoleId": 1,
      "consoleName": "Genesis/Mega Drive",
      "imageIcon": "/Images/085573.png"
    }
  ],
  "totalRequests": 5,
  "pointsForNext": 5000
}

Source

Repo	URL
RAWeb	https://github.com/RetroAchievements/RAWeb/blob/master/public/API/API_GetUserSetRequests.php
api-js	https://github.com/RetroAchievements/api-js/blob/main/src/user/getUserSetRequests.ts