Sign in

v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB
leaderboard

Get group leaderboard

post/v1/leaderboard.getGroupLeaderboard

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

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/V1LeaderboardGetGroupLeaderboardResponseBody.json",
  "groups": [
    {
      "avatar": "f1a1d2c3d0c9de1f2f3f4f5f6f7f8f9.jpg",
      "foundedAt": "2023-01-01T00:00:00Z",
      "id": 730,
      "members": 100,
      "name": "Group Name",
      "owner": {
        "appCost": 123456,
        "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",
        "foilBadgeCost": 123456,
        "foilBadges": 123456,
        "friends": 123456,
        "level": 123456,
        "name": "steamsets",
        "normalBadgeCost": 123456,
        "normalBadges": 123456,
        "playtime": 123456,
        "pointsGiven": 123456,
        "pointsReceived": 123456,
        "privacy": "public",
        "region": {
          "name": "Europe"
        },
        "state": {
          "name": "Baden-Wurttemberg"
        },
        "steamId": "76561198842603734",
        "steamSetsVanity": "steamsets",
        "steamVanity": "steamsets",
        "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": {
      "appCost": 123456,
      "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",
      "foilBadgeCost": 123456,
      "foilBadges": 123456,
      "friends": 123456,
      "level": 123456,
      "name": "steamsets",
      "normalBadgeCost": 123456,
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "xp": 123456
    },
    "privacy": "public",
    "rank": 1,
    "tag": "Group Tag",
    "vanity": "Group Vanity"
  }
}