Users I Follow
A call to this endpoint will retrieve the caller's "Following" users list.
On-site Representation
The user's Followers Users List page looks like:
HTTP Request
GET
https://retroachievements.org/API/API_GetUsersIFollow.php
Query Parameters
| Name | Required? | Description |
|---|---|---|
y | Yes | Your web API key. |
c | Count, number of records to return (default: 100, max: 500). | |
o | Offset, number of entries to skip (default: 0). |
Client Library
ts
import { buildAuthorization, getUsersIFollow } 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 usersIFollow = await getUsersIFollow(authorization);
// Note: a payload object can be specified as a second argument to alter
// the number of users returned and/or the starting offset.
//
// Example:
// const anotherSetOfUsersIFollow = await getUsersIFollow(authorization, {
// offset: 60,
// count: 20
// });Kotlin
val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api
val response: NetworkResponse<GetUsersIFollow.Response, ErrorResponse> = api.getUsersIFollow()
if (response is NetworkResponse.Success) {
// handle the data
val users: GetUsersIFollow.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": 20,
"Total": 120,
"Results": [
{
"User": "zuliman92",
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
"Points": 1882,
"PointsSoftcore": 258,
"IsFollowingMe": true
}
// ...
]
}json
{
"count": 20,
"total": 120,
"results": [
{
"user": "zuliman92",
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
"points": 1882,
"pointsSoftcore": 258,
"isFollowingMe": true
}
// ...
]
}