API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Global XP leaderboard

client.v1.retrieveLeaderboard(V1RetrieveLeaderboardParams { limit } query?, RequestOptionsoptions?): V1RetrieveLeaderboardResponse { entries }

GET/api/v1/leaderboard

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

ParametersExpand Collapse

query: V1RetrieveLeaderboardParams { limit }

limit?: number

Max results (1–100, default 25)

minimum1

maximum100

ReturnsExpand Collapse

V1RetrieveLeaderboardResponse { entries }

entries?: Array<LeaderboardEntry { image, name, rank, 3 more } >

image?: string | null

name?: string | null

rank?: number

streakDays?: number

username?: string | null

xp?: number

Global XP leaderboard

TypeScript

HTTP

TypeScript

import Racks from 'racks';

const client = new Racks();

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

console.log(response.entries);

200 example

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

Returns Examples

200 example

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