account

List account friends

Changed on
post/v1/account.listFriends

Request

  • Base URL: https://api.steamsets.com
  • URL: https://api.steamsets.com/v1/account.listFriends
  • Auth: HTTP bearer

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

includeStatsboolean

Add averages over all friends to the response

limitinteger

Friends per page

offsetinteger

Number of friends to skip, to go to a page directly. Ignored when cursor is set

order'asc' | 'desc'

Sort direction

searchstring

Return only friends whose name contains this text. The match ignores case

sort'friendsSince' | 'level' | 'badges' | 'apps' | 'playtime' | 'name'

Sort key. Equal keys keep the friendsSince order (newest first, then account id)

Example request

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

filteredTotalinteger required

Number of friends in this view across all pages: the friends that match the search and have a loaded account

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",
      "supporter": {
        "active": true,
        "months": 3
      },
      "themeColor": "#FF5733",
      "xp": 123456
    }
  ]
}

Changes

  • 753b5a0546a3Revision changes
    • info

      added the optional property // to the response with the status

  • 0a303d7a512cRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status