leaderboard

Get the top account in each value bucket

Changed on
post/v1/leaderboard.getBucketLeaders

Request

  • Base URL: https://api.steamsets.com
  • URL: https://api.steamsets.com/v1/leaderboard.getBucketLeaders
  • Auth: HTTP bearer

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

OK

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",
      "supporter": {
        "active": true,
        "months": 3
      },
      "themeColor": "#FF5733",
      "xp": 123456
    },
    "from": 10,
    "rank": 312,
    "score": 6342,
    "to": 19
  }
]

Changes

  • 708b7ffcfba3Revision changes
    • warning

      added the new amber_glint enum value to the // response property for the response status

    • warning

      added the new amethyst_glint enum value to the // response property for the response status

    • warning

      added the new astral_sky enum value to the // response property for the response status

    • warning

      added the new boost enum value to the // response property for the response status

    • warning

      added the new cosmic enum value to the // response property for the response status

    • warning

      added the new crown enum value to the // response property for the response status

    • warning

      added the new developer_scan enum value to the // response property for the response status

    • warning

      added the new diamond_fire enum value to the // response property for the response status

    • warning

      added the new emerald_depth enum value to the // response property for the response status

    • warning

      added the new glass enum value to the // response property for the response status

    • warning

      added the new halo enum value to the // response property for the response status

    • warning

      added the new lens enum value to the // response property for the response status

    • warning

      added the new molten enum value to the // response property for the response status

    • warning

      added the new nebula_sky enum value to the // response property for the response status

    • warning

      added the new ruby_fire enum value to the // response property for the response status

    • warning

      added the new sakura enum value to the // response property for the response status

    • warning

      added the new sapphire_depth enum value to the // response property for the response status

    • warning

      added the new staff_scan enum value to the // response property for the response status

    • warning

      added the new stardust enum value to the // response property for the response status

    • info

      removed the glitch enum value from the // response property for the response status

    • info

      removed the retro enum value from the // response property for the response status

    • info

      removed the stamped enum value from the // response property for the response status

    • info

      removed the sunken enum value from the // response property for the response status

    • info

      removed the typewriter enum value from the // response property for the response status

  • 753b5a0546a3Revision changes
    • info

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