## Global XP leaderboard

`client.v1.retrieveLeaderboard(V1RetrieveLeaderboardParamsquery?, RequestOptionsoptions?): V1RetrieveLeaderboardResponse`

**get** `/api/v1/leaderboard`

Returns the top users platform-wide, ranked by XP descending.

### Parameters

- `query: V1RetrieveLeaderboardParams`

  - `limit?: number`

    Max results (1–100, default 25)

### Returns

- `V1RetrieveLeaderboardResponse`

  - `entries?: Array<LeaderboardEntry>`

    - `image?: string | null`

    - `name?: string | null`

    - `rank?: number`

    - `streakDays?: number`

    - `username?: string | null`

    - `xp?: number`

### Example

```typescript
import Racks from 'racks';

const client = new Racks();

const response = await client.v1.retrieveLeaderboard();

console.log(response.entries);
```

#### Response

```json
{
  "entries": [
    {
      "image": "image",
      "name": "Alice",
      "rank": 1,
      "streakDays": 12,
      "username": "alice",
      "xp": 9800
    }
  ]
}
```