leaderboard

Get the top account in each value bucket

post/v1/leaderboard.getBucketLeaders

Request body

$schemastring uri

A URL to the JSON Schema for this object.

bucketSizeinteger

xp only: levels per bucket (default 10). Ignored for apps.

leaderboard'xp' | 'apps' required

xp buckets by level; apps buckets by the game-collector badge thresholds.

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1LeaderboardGetBucketLeadersRequestBody.json",
  "bucketSize": 10,
  "leaderboard": "xp"
}

Response

emptyboolean required

No account in this bucket within the scope

frominteger required

Inclusive bucket lower bound in the leaderboard's native unit (level for xp, game count for apps)

openboolean required

True when the bucket has no upper bound (e.g. the top apps tier); render as 'from+'.

rankinteger

scoreinteger

tointeger required

Inclusive bucket upper bound in the leaderboard's native unit. Ignore when open=true.

Example response

[
  {
    "account": {
      "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
    },
    "from": 10,
    "rank": 312,
    "score": 6342,
    "to": 19
  }
]

Changes

Changed in 2 of the 11 revisions of this API.42

Aug 5, 20262e8ba266b27f32See the full diff
- ▲
  removed the required property items/account/appCost from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/account/foilBadgeCost from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/account/normalBadgeCost from the response with the 200 status
  response-required-property-removed
- ○
  added the required property items/account/nameEffect to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/account/themeColor to the response with the 200 status
  response-required-property-added
Jul 31, 20268c1465a74c5f1See the full diff
- ▲
  removed the required property items/account/images from the response with the 200 status
  response-required-property-removed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 11 revisions, 1 has no diff computed.

Full history