Skip to main content
GET
/
leaderboards
/
players
List player leaderboard
curl --request GET \
  --url https://teambattles.gg/api/v1/leaderboards/players \
  --header 'Authorization: Bearer <token>'
{
  "players": [
    {
      "id": "<string>",
      "rank": 123,
      "user": {
        "id": "<string>",
        "username": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "createdAt": "<string>",
        "bannerUrl": "<string>",
        "isVerified": true,
        "bio": "<string>"
      },
      "stats": {
        "matchesPlayed": 4503599627370495,
        "wins": 4503599627370495,
        "losses": 4503599627370495,
        "winRate": 0.5,
        "experience": 1
      }
    }
  ],
  "timestamp": "<string>"
}

Permission Required

Player leaderboard reads require users.profile. Use GET /leaderboards/players/me/rank to get the API key owner’s rank. Player leaderboards are global; gameSlug is rejected on player leaderboard routes.

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

Response

Player leaderboard.

Player leaderboard response.

players
object[]
required
sortBy
enum<string>
required

Supported leaderboard sort field.

Available options:
wins,
winRate,
experience
timestamp
string
required