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 '{
  "app": {
    "appId": 730
  },
  "badge": {
    "id": 1,
    "isFoil": true
  },
  "end": 10,
  "goToLeaderboardRank": 1,
  "leaderboard": "xp",
  "location": [
    {
      "city": "Bad Krozingen",
      "country": "Germany",
      "region": "Europe",
      "state": "Baden-Wurttemberg"
    }
  ],
  "start": 1
}'
{
  "$schema": "https://api.steamsets.com/schemas/V1LeaderboardGetAccountLeaderboardResponseBody.json",
  "accounts": [
    {
      "appCost": 123456,
      "appPlaytime": 1000,
      "apps": 123456,
      "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
      "awardsGiven": 123456,
      "awardsReceived": 123456,
      "badgeInfo": {
        "completionTime": "2023-01-01T00:00:00Z",
        "level": 123456,
        "xp": 123456
      },
      "badges": 123456,
      "bans": 1,
      "city": {
        "name": "Bad Krozingen"
      },
      "country": {
        "code": "DE",
        "name": "Germany"
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "donated": 123456,
      "economyBan": "steam",
      "foilBadgeCost": 123456,
      "foilBadges": 123456,
      "friends": 123456,
      "gameBans": 1,
      "level": 123456,
      "name": "steamsets",
      "normalBadgeCost": 123456,
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "rank": 1,
      "region": {
        "name": "Europe"
      },
      "roles": [
        {
          "extras": {},
          "rating": 123,
          "role": "user"
        }
      ],
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsScore": 1,
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "vacBans": 1,
      "xp": 123456
    }
  ],
  "app": {
    "id": 730,
    "image": "https://cdn.cloudflare.steamstatic.com/steamcommunity/public/images/apps/730/a1a2f9f3f4c0c2b1f8d3a4e5f6d7e8f9.jpg",
    "name": "Counter-Strike: Global Offensive",
    "type": "game"
  },
  "badgeInfo": {
    "appId": 730,
    "appImage": "https://cdn.cloudflare.steamstatic.com/steamcommunity/public/images/apps/730/a1a2f9f3f4c0c2b1f8d3a4e5f6d7e8f9.jpg",
    "appName": "Counter-Strike: Global Offensive",
    "image": "https://cdn.cloudflare.steamstatic.com/steamcommunity/public/images/apps/730/a1a2f9f3f4c0c2b1f8d3a4e5f6d7e8f9.jpg",
    "isFoil": true,
    "level": 15,
    "name": "Counter-Strike: Global Offensive"
  },
  "hiddenRanks": [
    1
  ],
  "location": [
    {
      "cityName": "Bad Krozingen",
      "countryCode": "DE",
      "countryName": "Germany",
      "region": "Europe",
      "stateName": "Baden-Wurttemberg"
    }
  ],
  "ownAccount": {
    "appCost": 123456,
    "appPlaytime": 1000,
    "apps": 123456,
    "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
    "awardsGiven": 123456,
    "awardsReceived": 123456,
    "badgeInfo": {
      "completionTime": "2023-01-01T00:00:00Z",
      "level": 123456,
      "xp": 123456
    },
    "badges": 123456,
    "bans": 1,
    "city": {
      "name": "Bad Krozingen"
    },
    "country": {
      "code": "DE",
      "name": "Germany"
    },
    "createdAt": "2023-01-01T00:00:00Z",
    "donated": 123456,
    "economyBan": "steam",
    "foilBadgeCost": 123456,
    "foilBadges": 123456,
    "friends": 123456,
    "gameBans": 1,
    "level": 123456,
    "name": "steamsets",
    "normalBadgeCost": 123456,
    "normalBadges": 123456,
    "playtime": 123456,
    "pointsGiven": 123456,
    "pointsReceived": 123456,
    "privacy": "public",
    "rank": 1,
    "region": {
      "name": "Europe"
    },
    "roles": [
      {
        "extras": {},
        "rating": 123,
        "role": "user"
      }
    ],
    "state": {
      "name": "Baden-Wurttemberg"
    },
    "steamId": "76561198842603734",
    "steamSetsScore": 1,
    "steamSetsVanity": "steamsets",
    "steamVanity": "steamsets",
    "vacBans": 1,
    "xp": 123456
  },
  "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
Examples:

"xp"

​
app
object | null

For a given app leaderboard, the app id

​
badge
object | null

For a given badge leaderboard, the steam badge id

​
end
integer | null

The end index

Required range: x >= 0
Examples:

10

​
goToLeaderboardRank
integer | null

The rank to go to

Required range: x >= 0
Examples:

1

​
location
array | null

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

​
start
integer | null

The start index

Required range: x >= 0
Examples:

1

Response

OK

​
accounts
array | null
required
​
$schema
string<uri>

A URL to the JSON Schema for this object.

Examples:

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

​
app
object | null
​
badgeInfo
object | null
​
hiddenRanks
integer[] | null

The ranks that are hidden in the leaderboard

​
location
object[] | null
​
ownAccount
object | null

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

​
rankedOutOf
integer
default:0

The number of accounts that are ranked in the leaderboard

Required range: x >= 0