Skip to main content
POST
/
v1
/
leaderboard.getAccountLeaderboard
Get account leaderboard
curl --request POST \
  --url https://api.steamsets.com/v1/leaderboard.getAccountLeaderboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "leaderboard": "apps",
  "app": {
    "appId": 1
  },
  "badge": {
    "id": 1,
    "isFoil": true
  },
  "end": 1,
  "goToLeaderboardRank": 1,
  "location": [
    {
      "city": "<string>",
      "country": "<string>",
      "region": "<string>",
      "state": "<string>"
    }
  ],
  "start": 1
}
'
{
  "accounts": [
    {
      "appCost": 1,
      "appPlaytime": 1,
      "apps": 1,
      "avatar": "<string>",
      "awardsGiven": 1,
      "awardsReceived": 1,
      "badges": 1,
      "bans": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "donated": 1,
      "economyBan": "<string>",
      "foilBadgeCost": 1,
      "foilBadges": 1,
      "friends": 1,
      "gameBans": 1,
      "level": 1,
      "name": "<string>",
      "normalBadgeCost": 1,
      "normalBadges": 1,
      "playtime": 1,
      "pointsGiven": 1,
      "pointsReceived": 1,
      "privacy": "public",
      "rank": 1,
      "roles": [
        {
          "extras": {},
          "rating": 123,
          "role": "user"
        }
      ],
      "steamId": "<string>",
      "steamSetsScore": 1,
      "steamSetsVanity": "<string>",
      "steamVanity": "<string>",
      "vacBans": 1,
      "xp": 1,
      "badgeInfo": {
        "completionTime": "2023-11-07T05:31:56Z",
        "level": 1,
        "xp": 1
      },
      "city": {
        "name": "<string>"
      },
      "country": {
        "name": "<string>",
        "code": "<string>"
      },
      "region": {
        "name": "<string>"
      },
      "state": {
        "name": "<string>"
      }
    }
  ],
  "$schema": "<string>",
  "app": {
    "id": 1,
    "image": "<string>",
    "name": "<string>",
    "type": "<string>"
  },
  "badgeInfo": {
    "appId": 1,
    "appImage": "<string>",
    "appName": "<string>",
    "image": "<string>",
    "isFoil": true,
    "level": 1,
    "name": "<string>"
  },
  "hiddenRanks": [
    1
  ],
  "location": [
    {
      "cityName": "<string>",
      "countryCode": "<string>",
      "countryName": "<string>",
      "region": "<string>",
      "stateName": "<string>"
    }
  ],
  "ownAccount": {
    "appCost": 1,
    "appPlaytime": 1,
    "apps": 1,
    "avatar": "<string>",
    "awardsGiven": 1,
    "awardsReceived": 1,
    "badges": 1,
    "bans": 1,
    "createdAt": "2023-11-07T05:31:56Z",
    "donated": 1,
    "economyBan": "<string>",
    "foilBadgeCost": 1,
    "foilBadges": 1,
    "friends": 1,
    "gameBans": 1,
    "level": 1,
    "name": "<string>",
    "normalBadgeCost": 1,
    "normalBadges": 1,
    "playtime": 1,
    "pointsGiven": 1,
    "pointsReceived": 1,
    "privacy": "public",
    "rank": 1,
    "roles": [
      {
        "extras": {},
        "rating": 123,
        "role": "user"
      }
    ],
    "steamId": "<string>",
    "steamSetsScore": 1,
    "steamSetsVanity": "<string>",
    "steamVanity": "<string>",
    "vacBans": 1,
    "xp": 1,
    "badgeInfo": {
      "completionTime": "2023-11-07T05:31:56Z",
      "level": 1,
      "xp": 1
    },
    "city": {
      "name": "<string>"
    },
    "country": {
      "name": "<string>",
      "code": "<string>"
    },
    "region": {
      "name": "<string>"
    },
    "state": {
      "name": "<string>"
    }
  },
  "rankedOutOf": 0
}
This endpoint supports API key authentication for external integrations

​
API Access

This endpoint can be accessed using:
  • API Keys: For external applications and integrations
  • User Sessions: For web application access
See our API documentation for authentication details.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
leaderboard
enum<string>
required

The leaderboard to get

Available options:
apps,
app_playtime,
app_valid_playtime,
awards_given,
awards_received,
bans,
game_bans,
vac_bans,
donations,
foil_badges,
normal_badges,
badges,
playtime,
valid_playtime,
points_given,
points_received,
steam_sets,
xp,
badge_completion_time,
badge_highest_level
Example:

"xp"

​
app
object

For a given app leaderboard, the app id

​
badge
object

For a given badge leaderboard, the steam badge id

​
end
integer<int32> | null

The end index

Required range: x >= 0
Example:

10

​
goToLeaderboardRank
integer<int32> | null

The rank to go to

Required range: x >= 0
Example:

1

​
location
(object | null)[] | null

The location(s)to get the leaderboard for, otherwise global

​
start
integer<int32> | null

The start index

Required range: x >= 0
Example:

1

Response

OK

​
accounts
(object | null)[] | null
required
​
$schema
string<uri>

A URL to the JSON Schema for this object.

Example:

"https://api.steamsets.com/schemas/V1LeaderboardGetAccountLeaderboardResponseBody.json"

​
app
object
​
badgeInfo
object
​
hiddenRanks
integer<int32>[] | null

The ranks that are hidden in the leaderboard

Required range: x >= 0
​
location
object[] | null
​
ownAccount
object

The account that is currently logged in, if its not already in the leaderboard

​
rankedOutOf
integer<int32>
default:0

The number of accounts that are ranked in the leaderboard

Required range: x >= 0