Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

sort
enum<string>
default:unrealizedPnl

Ranking. realizedPnlPct is deprecated and is the same as totalPnlPct. See the description.

Available options:
unrealizedPnl,
unrealizedPnlPct,
totalPnl,
realizedPnlPct,
totalPnlPct
window
enum<string>
default:alltime

PnL window.

Available options:
day,
week,
month,
alltime
limit
integer
default:50

Rows to return, at most 100.

Required range: 1 <= x <= 100
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.