Skip to main content
GET
Read one capture of a platform leaderboard

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

platform
enum<string>
required

The platform that publishes the board.

Available options:
fomo,
pump,
hyperliquid,
markets,
polymarket,
legend,
risex
board
string
required

The board name, as GET /v3/leaderboards lists it.

Pattern: ^[a-z][a-z0-9_]{0,63}$

Query Parameters

window
enum<string>

One of the board's windows. Leave it out for its defaultWindow. A board without windows answers 400 to any value.

Available options:
24h,
7d,
30d,
90d,
all
at
string<date-time>

An RFC3339 time with Z or an offset, not in the future. Answers the newest capture at or before it. Leave it out for the newest capture.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

OK

One capture of a platform leaderboard, as the platform showed it.

platform
enum<string>
required

The platform that publishes the board.

Available options:
fomo,
pump,
hyperliquid,
markets,
polymarket,
legend,
risex
board
string
required

The board name, unique within its platform.

category
enum<string>
required

What the board or ranking ranks.

Available options:
perp_trading,
spot_trading,
prediction,
content,
impressions,
social,
referrals,
tokens,
groups
metric
enum<string> | null
required

The metric the board sorts by, or null when the platform does not say.

Available options:
pnl,
net_flow,
portfolio_value,
price,
liquidity,
roi,
volume,
trade_count,
win_rate,
impressions,
views,
likes,
followers,
holders,
market_cap,
members,
points,
realized_pnl,
unrealized_pnl
window
enum<string> | null
required

The window of this capture, or null for a board without windows.

Available options:
24h,
7d,
30d,
90d,
all
capturedAt
string<date-time>
required

When we captured the board.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z))$
entryCount
integer
required

Entries the capture stored. entries leaves out a subject we cannot read.

Required range: 0 <= x <= 9007199254740991
entries
object[]
required

The entries of the capture by rank, not paged. An entry whose subject we cannot read is left out, so entries can hold fewer rows than entryCount.