Sign in
leaderboard

Preview account rank

post/v1/leaderboard.previewAccountRank

Request body

$schemastring uri

A URL to the JSON Schema for this object.

leaderboard'apps' | 'awards_given' | 'awards_received' | 'bans' | 'game_bans' | 'vac_bans' | 'donations' | 'foil_badges' | 'normal_badges' | 'badges' | 'playtime' | 'points_given' | 'points_received' | 'steam_sets' | 'xp' required

The leaderboard to get

valueinteger nullable

What their leaderboard score would be, will use their current rank if not set

Example request

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

rankedOutOfinteger

The number of accounts that are ranked in the leaderboard

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1LeaderboardPreviewAccountRankResponseBody.json",
  "ownAccount": {
    "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",
    "differenceToUs": 10,
    "donated": 123456,
    "economyBan": "steam",
    "foilBadges": 123456,
    "friends": 123456,
    "level": 123456,
    "name": "steamsets",
    "nameEffect": "rainbow",
    "normalBadges": 123456,
    "playtime": 123456,
    "pointsGiven": 123456,
    "pointsReceived": 123456,
    "privacy": "public",
    "rank": 1,
    "region": {
      "name": "Europe"
    },
    "score": 100,
    "state": {
      "name": "Baden-Wurttemberg"
    },
    "steamId": "76561198842603734",
    "steamSetsVanity": "steamsets",
    "steamVanity": "steamsets",
    "themeColor": "#FF5733",
    "xp": 123456
  },
  "rankedAbove": {
    "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",
    "differenceToUs": 10,
    "donated": 123456,
    "economyBan": "steam",
    "foilBadges": 123456,
    "friends": 123456,
    "level": 123456,
    "name": "steamsets",
    "nameEffect": "rainbow",
    "normalBadges": 123456,
    "playtime": 123456,
    "pointsGiven": 123456,
    "pointsReceived": 123456,
    "privacy": "public",
    "rank": 1,
    "region": {
      "name": "Europe"
    },
    "score": 100,
    "state": {
      "name": "Baden-Wurttemberg"
    },
    "steamId": "76561198842603734",
    "steamSetsVanity": "steamsets",
    "steamVanity": "steamsets",
    "themeColor": "#FF5733",
    "xp": 123456
  },
  "rankedBelow": {
    "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",
    "differenceToUs": 10,
    "donated": 123456,
    "economyBan": "steam",
    "foilBadges": 123456,
    "friends": 123456,
    "level": 123456,
    "name": "steamsets",
    "nameEffect": "rainbow",
    "normalBadges": 123456,
    "playtime": 123456,
    "pointsGiven": 123456,
    "pointsReceived": 123456,
    "privacy": "public",
    "rank": 1,
    "region": {
      "name": "Europe"
    },
    "score": 100,
    "state": {
      "name": "Baden-Wurttemberg"
    },
    "steamId": "76561198842603734",
    "steamSetsVanity": "steamsets",
    "steamVanity": "steamsets",
    "themeColor": "#FF5733",
    "xp": 123456
  }
}

Changes

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

  • 2e8ba266b27f96See the full diff
    • ▲

      removed the required property ownAccount/appCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property ownAccount/foilBadgeCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property ownAccount/normalBadgeCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedAbove/appCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedAbove/foilBadgeCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedAbove/normalBadgeCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedBelow/appCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedBelow/foilBadgeCost from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedBelow/normalBadgeCost from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property ownAccount/nameEffect to the response with the 200 status

      response-required-property-added

    • ○

      added the required property ownAccount/themeColor to the response with the 200 status

      response-required-property-added

    • ○

      added the required property rankedAbove/nameEffect to the response with the 200 status

      response-required-property-added

    • ○

      added the required property rankedAbove/themeColor to the response with the 200 status

      response-required-property-added

    • ○

      added the required property rankedBelow/nameEffect to the response with the 200 status

      response-required-property-added

    • ○

      added the required property rankedBelow/themeColor to the response with the 200 status

      response-required-property-added

  • 8c1465a74c5f3See the full diff
    • ▲

      removed the required property ownAccount/images from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedAbove/images from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property rankedBelow/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.