Skip to main content
GET
/
user
/
game-ranks
List the API key owner's game ranks
curl --request GET \
  --url https://teambattles.gg/api/v1/user/game-ranks \
  --header 'Authorization: Bearer <token>'
{
  "gameRanks": [
    {
      "id": "<string>",
      "gameId": "<string>",
      "mode": "<string>",
      "sr": 123,
      "isTop250": true,
      "top250Rank": 0,
      "winstreak": 0,
      "updatedAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "count": 4503599627370495,
  "timestamp": "<string>"
}

​
Permission Required

This endpoint requires game.ranks:read on your API key. The user is always the API key owner, derived from the key itself - it is never accepted as a parameter, so a key can only read its own ranks.

​
Access / Membership Rules

This is a self-read route. The owner is always derived from principal.user._id, so there is no membership or participant gating - the key reads exactly the owner’s own game ranks.

​
What’s Returned

Returns an object with a gameRanks array, a count of how many ranks were returned, and a timestamp. Each rank entry is the API-safe projection (structured rank columns - gameId, mode, source, sr, isTop250, top250Rank, winstreak, plus createdAt / updatedAt), never the freeform raw rank blob. Mintlify renders the full schema from the spec below.

Authorizations

​
Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Response

The API key owner's game ranks.

The API key owner's game ranks.

​
gameRanks
object[]
required
​
count
integer
required
Required range: 0 <= x <= 9007199254740991
​
timestamp
string
required

ISO 8601 response timestamp.