Skip to main content
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 '
{
  "leaderboard": "most_members",
  "end": 1,
  "goToLeaderboardRank": 1,
  "start": 1
}
'
{
  "groups": [
    {
      "avatar": "<string>",
      "foundedAt": "2023-11-07T05:31:56Z",
      "id": 1,
      "members": 123,
      "name": "<string>",
      "owner": {
        "appCost": 1,
        "apps": 1,
        "avatar": "<string>",
        "awardsGiven": 1,
        "awardsReceived": 1,
        "badges": 1,
        "bans": 1,
        "createdAt": "2023-11-07T05:31:56Z",
        "donated": 1,
        "economyBan": "<string>",
        "foilBadgeCost": 1,
        "foilBadges": 1,
        "friends": 1,
        "gameBans": 1,
        "level": 1,
        "name": "<string>",
        "normalBadgeCost": 1,
        "normalBadges": 1,
        "playtime": 1,
        "pointsGiven": 1,
        "pointsReceived": 1,
        "privacy": "public",
        "roles": [
          {
            "extras": {},
            "rating": 123,
            "role": "user"
          }
        ],
        "steamId": "<string>",
        "steamSetsScore": 1,
        "steamSetsVanity": "<string>",
        "steamVanity": "<string>",
        "vacBans": 1,
        "xp": 1,
        "city": {
          "name": "<string>"
        },
        "country": {
          "name": "<string>",
          "code": "<string>"
        },
        "region": {
          "name": "<string>"
        },
        "state": {
          "name": "<string>"
        }
      },
      "privacy": "public",
      "rank": 1,
      "tag": "<string>",
      "vanity": "<string>"
    }
  ],
  "steamSetsGroup": {
    "avatar": "<string>",
    "foundedAt": "2023-11-07T05:31:56Z",
    "id": 1,
    "members": 123,
    "name": "<string>",
    "owner": {
      "appCost": 1,
      "apps": 1,
      "avatar": "<string>",
      "awardsGiven": 1,
      "awardsReceived": 1,
      "badges": 1,
      "bans": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "donated": 1,
      "economyBan": "<string>",
      "foilBadgeCost": 1,
      "foilBadges": 1,
      "friends": 1,
      "gameBans": 1,
      "level": 1,
      "name": "<string>",
      "normalBadgeCost": 1,
      "normalBadges": 1,
      "playtime": 1,
      "pointsGiven": 1,
      "pointsReceived": 1,
      "privacy": "public",
      "roles": [
        {
          "extras": {},
          "rating": 123,
          "role": "user"
        }
      ],
      "steamId": "<string>",
      "steamSetsScore": 1,
      "steamSetsVanity": "<string>",
      "steamVanity": "<string>",
      "vacBans": 1,
      "xp": 1,
      "city": {
        "name": "<string>"
      },
      "country": {
        "name": "<string>",
        "code": "<string>"
      },
      "region": {
        "name": "<string>"
      },
      "state": {
        "name": "<string>"
      }
    },
    "privacy": "public",
    "rank": 1,
    "tag": "<string>",
    "vanity": "<string>"
  },
  "$schema": "<string>",
  "rankedOutOf": 0
}
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
Example:

"most_members"

​
end
integer<int32> | null

The end index

Required range: x >= 0
Example:

10

​
goToLeaderboardRank
integer<int32> | null

The rank to go to

Required range: x >= 0
Example:

1

​
start
integer<int32> | null

The start index

Required range: x >= 0
Example:

1

Response

OK

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

A URL to the JSON Schema for this object.

Example:

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

​
rankedOutOf
integer<int32>
default:0

The number of accounts that are ranked in the leaderboard

Required range: x >= 0