Skip to main content
GET
Wallet leaderboard ranked by realised PnL or volume

Query Parameters

period
enum<string>
default:today

Which period to rank — defaults to today.

Available options:
today,
week,
month,
all
sort
enum<string>
default:pnl

Sort field. pnl (default) returns the canonical PnL leaderboard; volume re-orders the same period snapshot by notional traded desc.

Available options:
pnl,
volume

Optional case-insensitive prefix. Routes to wallet search when the value looks 0x-hex, username search otherwise.

limit
integer
default:20

Page size, 1–50; defaults to 20.

Required range: 1 <= x <= 50
cursor
string

Opaque cursor returned by a previous page.

Response

OK

period
enum<string>
required
Available options:
today,
week,
month,
all
snapshotAt
string<date-time>
required

Wall-clock at which the recompute cron sampled the data feeding this page. Frontends can render "snapshot 2 min ago" directly off this field.

total
integer
required

Total entries in the leaderboard for this period — independent of the page slice. Drives page-count rendering.

entries
object[]
required
nextCursor
string | null
required

Opaque keyset cursor for the next page; null on the last page.

me
object | null
required

The authenticated caller's row for the same period. Populated when the request carries a valid Privy JWT or API key AND the wallet has a deployed vault. rank is null when the caller has no realised activity yet (pnl="0", volume="0"); the FE should render an "unranked" personal block in that case. null for anonymous traffic, or for authed callers whose vault has not been deployed.