Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Path Parameters

coin
string
required

Market, for example BTC or xyz:TSLA.

Query Parameters

window
enum<string>
default:30d

Window. The default is 30d, as on the per-market leaderboard on hyperdash.com.

Available options:
24h,
7d,
30d,
ytd,
alltime
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
limit
integer
default:50

Rows to return, at most 100.

Required range: 1 <= x <= 100

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.