Sign in

v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB
leaderboard

Get account leaderboard

post/v1/leaderboard.getAccountLeaderboard

Request body

$schemastring uri

A URL to the JSON Schema for this object.

endinteger nullable

The end index

goToLeaderboardRankinteger nullable

The rank to go to

leaderboard'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' required

The leaderboard to get

startinteger nullable

The start index

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1LeaderboardGetAccountLeaderboardRequestBody.json",
  "app": {
    "appId": 730
  },
  "badge": {
    "isFoil": true
  },
  "end": 10,
  "goToLeaderboardRank": 1,
  "leaderboard": "xp",
  "location": [
    {
      "city": "Bad Krozingen",
      "country": "Germany",
      "region": "Europe",
      "state": "Baden-Wurttemberg"
    }
  ],
  "start": 1
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

hiddenRanksinteger[] nullable

The ranks that are hidden in the leaderboard

rankedOutOfinteger

The number of accounts that are ranked in the leaderboard

Example response

{
  "$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,
      "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,
      "level": 123456,
      "name": "steamsets",
      "normalBadgeCost": 123456,
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "rank": 1,
      "region": {
        "name": "Europe"
      },
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "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"
  },
  "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,
    "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,
    "level": 123456,
    "name": "steamsets",
    "normalBadgeCost": 123456,
    "normalBadges": 123456,
    "playtime": 123456,
    "pointsGiven": 123456,
    "pointsReceived": 123456,
    "privacy": "public",
    "rank": 1,
    "region": {
      "name": "Europe"
    },
    "state": {
      "name": "Baden-Wurttemberg"
    },
    "steamId": "76561198842603734",
    "steamSetsVanity": "steamsets",
    "steamVanity": "steamsets",
    "xp": 123456
  }
}