Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Path Parameters

address
string
required

Wallet address: 0x followed by 40 hex characters.

Query Parameters

window
enum<string>
default:alltime

Window.

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

Asset category for the all-markets leaderboard. Leave it out when using coin.

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
coin
string

One market's leaderboard instead of a category, for example BTC or xyz:GOLD. Case-sensitive.

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.