Skip to main content
GET
Read the newest snapshot of one of our rankings

Authorizations

Authorization
string
header
required

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

Path Parameters

key
string
required

A ranking key, as GET /v3/rankings lists it.

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

Query Parameters

order
enum<string>
default:best

best (the default): rank 1 first. worst: the bottom entries, lowest value first.

Available options:
best,
worst

Response

OK

The newest snapshot of one of our rankings.

key
string
required

The ranking key, for GET /v3/rankings/{key}.

title
string
required

A title to show.

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>
required

The metric the ranking orders by.

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 time window of the metric, or null for no window.

Available options:
24h,
7d,
30d,
90d,
all
order
enum<string>
required

best: the top entries. worst: the bottom entries, lowest value first.

Available options:
best,
worst
dataAsOf
string<date-time>
required

The time of the newest data the snapshot used.

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))$
computedAt
string<date-time>
required

When we computed the snapshot.

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))$
total
integer
required

Subjects ranked. entries holds at most size of them.

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

The entries in order. Not paged.