Skip to main content
GET
/
leaderboards
/
teams
List team leaderboard
curl --request GET \
  --url https://teambattles.gg/api/v1/leaderboards/teams \
  --header 'Authorization: Bearer <token>'
{
  "teams": [
    {
      "id": "<string>",
      "rank": 123,
      "team": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "tag": "<string>",
        "avatarUrl": "<string>"
      },
      "stats": {
        "matchesPlayed": 4503599627370495,
        "wins": 4503599627370495,
        "losses": 4503599627370495,
        "winRate": 0.5,
        "experience": 1
      },
      "gameSlug": "<string>"
    }
  ],
  "gameSlug": "<string>",
  "timestamp": "<string>"
}

Permission Required

Team leaderboard reads require teams.profile. Use GET /leaderboards/teams/{identifier}/rank to get a team’s rank. Private teams are excluded from API leaderboard rows.

Authorizations

Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Query Parameters

sortBy
enum<string>

Supported leaderboard sort field.

Available options:
wins,
winRate,
experience
limit
integer
Required range: 1 <= x <= 100
gameSlug
string

Response

Team leaderboard.

Team leaderboard response.

teams
object[]
required
sortBy
enum<string>
required

Supported leaderboard sort field.

Available options:
wins,
winRate,
experience
gameSlug
string | null
required
timestamp
string
required