leaderboard

Get group leaderboard

Changed on Oct 15, 2026

post/v1/leaderboard.getGroupLeaderboard

Request

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

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

The leaderboard to get

startinteger nullable

The start index

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1LeaderboardGetGroupLeaderboardRequestBody.json",
  "end": 10,
  "goToLeaderboardRank": 1,
  "leaderboard": "most_members",
  "start": 1
}

Response

$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/V1LeaderboardGetGroupLeaderboardResponseBody.json",
  "groups": [
    {
      "avatar": "f1a1d2c3d0c9de1f2f3f4f5f6f7f8f9.jpg",
      "foundedAt": "2023-01-01T00:00:00Z",
      "id": 730,
      "members": 100,
      "name": "Group Name",
      "owner": {
        "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
      },
      "privacy": "public",
      "rank": 1,
      "tag": "Group Tag",
      "vanity": "Group Vanity"
    }
  ],
  "steamSetsGroup": {
    "avatar": "f1a1d2c3d0c9de1f2f3f4f5f6f7f8f9.jpg",
    "foundedAt": "2023-01-01T00:00:00Z",
    "id": 730,
    "members": 100,
    "name": "Group Name",
    "owner": {
      "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
    },
    "privacy": "public",
    "rank": 1,
    "tag": "Group Tag",
    "vanity": "Group Vanity"
  }
}

Changes

Oct 15, 2026708b7ffcfba3 Revision changes
- warning
  added the new amber_glint enum value to the /// response property for the response status
- 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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
- 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 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 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 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 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
- info
  removed the typewriter enum value from the // response property for the response status
Oct 9, 2026753b5a0546a3 Revision changes
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status

Operation history (4 revisions)