POST
/
v1
/
leaderboard.getGroupLeaderboard
Get group leaderboard
curl --request POST \
  --url https://api.steamsets.com/v1/leaderboard.getGroupLeaderboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "end": 10,
  "goToLeaderboardRank": 1,
  "leaderboard": "most_members",
  "start": 1
}'
{
  "$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,
        "bans": 1,
        "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,
        "gameBans": 1,
        "level": 123456,
        "name": "steamsets",
        "normalBadgeCost": 123456,
        "normalBadges": 123456,
        "playtime": 123456,
        "pointsGiven": 123456,
        "pointsReceived": 123456,
        "privacy": "public",
        "region": {
          "name": "Europe"
        },
        "roles": [
          {
            "extras": {},
            "rating": 123,
            "role": "user"
          }
        ],
        "state": {
          "name": "Baden-Wurttemberg"
        },
        "steamId": "76561198842603734",
        "steamSetsScore": 1,
        "steamSetsVanity": "steamsets",
        "steamVanity": "steamsets",
        "vacBans": 1,
        "xp": 123456
      },
      "privacy": "public",
      "rank": 1,
      "tag": "Group Tag",
      "vanity": "Group Vanity"
    }
  ],
  "rankedOutOf": 0,
  "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,
      "bans": 1,
      "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,
      "gameBans": 1,
      "level": 123456,
      "name": "steamsets",
      "normalBadgeCost": 123456,
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "roles": [
        {
          "extras": {},
          "rating": 123,
          "role": "user"
        }
      ],
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsScore": 1,
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "vacBans": 1,
      "xp": 123456
    },
    "privacy": "public",
    "rank": 1,
    "tag": "Group Tag",
    "vanity": "Group Vanity"
  }
}
This endpoint supports API key authentication for external integrations

​
API Access

This endpoint can be accessed using:
  • API Keys: For external applications and integrations
  • User Sessions: For web application access
See our API documentation for authentication details.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
leaderboard
enum<string>
required

The leaderboard to get

Available options:
most_members
Examples:

"most_members"

​
end
integer | null

The end index

Required range: x >= 0
Examples:

10

​
goToLeaderboardRank
integer | null

The rank to go to

Required range: x >= 0
Examples:

1

​
start
integer | null

The start index

Required range: x >= 0
Examples:

1

Response

OK

​
groups
object[] | null
required
​
steamSetsGroup
object
required
​
$schema
string<uri>

A URL to the JSON Schema for this object.

Examples:

"https://api.steamsets.com/schemas/V1LeaderboardGetGroupLeaderboardResponseBody.json"

​
rankedOutOf
integer
default:0

The number of accounts that are ranked in the leaderboard

Required range: x >= 0