---
title: "Get Leaderboard"
method: GET
path: "/api/v1/user/leaderboard"
tags: ["Leaderboard"]
---

# Get Leaderboard

`GET /api/v1/user/leaderboard`

Returns a paginated leaderboard of subaccounts ranked by unrealised PnL for the given timeframe. Timeframe is required and relative to now (today, 7d, 30d, or all). Default limit 10, max 100; default offset 0.

## Query parameters

- `offset` integer, nullable
- `limit` integer, nullable
- `timeframe` 'today' | '7d' | '30d' | 'all', required — Leaderboard ranking window: today, last 7 days, last 30 days, or all time.

## Response `200`

Leaderboard

- LeaderboardResponse — Paginated leaderboard list response.
  - `data` LeaderboardData[], required — Leaderboard rows.
    - `account_value` string, required — Equity in quote units (e.g. USDC).
    - `place` string, required — Rank position (1-based), or "0" when not ranked.
    - `pnl` string, required — Unrealised PnL in quote units.
    - `ranked` boolean, required — Whether this entry is on the board (false when not ranked).
    - `referral_xp` integer, required — XP earned from referral bonuses.
    - `roi` string, required — Return on investment as a decimal string (e.g. "0.05" for 5%).
    - `sub_account_address` string, required — Subaccount address.
    - `total_xp` integer, required — Total XP balance.
    - `trading_xp` integer, required — XP earned from trading activity.
    - `volume` string, required — Cumulative volume in quote units.
  - `meta` LeaderboardMeta, required — Pagination metadata for a leaderboard list response.
    - `limit` integer, required — Applied limit.
    - `offset` integer, required — Applied offset.
    - `total` integer, required — Total number of entries in the window.

---

[API](https://skmtc.net/ekidenfi/apis/ekiden-gateway.md) · [All operations](https://skmtc.net/ekidenfi/apis/ekiden-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ekidenfi/ekiden-gateway/revisions/75ffe546b73a/schema)