Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

window
enum<string>
default:30d

Ranking window. Defaults to 30d, as on the hyperdash.com leaderboard.

Available options:
alltime,
24h,
7d,
30d,
ytd
category
enum<string>
default:all

Asset category.

Available options:
all,
crypto,
majors,
memes,
alts,
equities,
indices,
commodities,
fx
sort
enum<string>
default:total

Ranked metric: total for net PnL, realized, unrealized, or their ROI. ROI is the PnL divided by capital, for wallets with capital of at least 1,000 USD. Wallets without that value are not ranked.

Available options:
total,
realized,
unrealized,
roi,
realized_roi,
unrealized_roi
min_trades
integer
default:0

Minimum completed trades.

Required range: 0 <= x <= 1000000
min_account_value
enum<string>

Only wallets with at least this account value, in USD. This is the equity filter on hyperdash.com. It filters on the leaderboard's hourly account value, so the live value returned can differ slightly.

Available options:
1000,
10000,
100000,
1000000,
10000000
max_account_value
enum<string>

Only wallets with at most this account value, in USD. Filtered on the leaderboard's hourly value, like min_account_value.

Available options:
10000,
100000,
1000000,
10000000,
100000000
limit
integer
default:100

Rows per page.

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

Opaque cursor from next_cursor.

Response

OK

data
object[]
required

Result rows.

has_more
boolean
required

true when another page follows.

next_cursor
string | null
required

Cursor for the next page, passed as cursor. null on the last page.

meta
object
required

Response metadata. Its keys depend on the endpoint and are described above.