v6

OpenAPI 3.1.02026-08-0597255315.1 KB
account

List account friends

post/v1/account.listFriends

Request body

$schemastring uri

A URL to the JSON Schema for this object.

cursorstring

Opaque cursor from a previous page's nextCursor. Omit for the first page

limitinteger

Friends per page

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountListFriendsRequestBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

nextCursorstring nullable required

Cursor for the next page, null when this is the last page

totalinteger required

Total number of friends across all pages

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountListFriendsResponseBody.json",
  "friends": [
    {
      "apps": 123456,
      "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
      "awardsGiven": 123456,
      "awardsReceived": 123456,
      "badges": 123456,
      "city": {
        "name": "Bad Krozingen"
      },
      "country": {
        "code": "DE",
        "name": "Germany"
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "donated": 123456,
      "economyBan": "steam",
      "foilBadges": 123456,
      "friends": 123456,
      "level": 123456,
      "name": "steamsets",
      "nameEffect": "rainbow",
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "themeColor": "#FF5733",
      "xp": 123456
    }
  ]
}