Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Path Parameters

cohort
enum<string>
required

Account-size cohort.

Available options:
small,
medium,
large,
whale,
apex

Query Parameters

coin
string

One market, to return its position rows.

sort
enum<string>
default:account_value

account_value, notional, upnl for the largest gain or upnl_loss for the largest loss.

Available options:
account_value,
notional,
upnl,
upnl_loss
limit
integer
default:50

Rows to return, at most 100.

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

Opaque cursor from next_cursor, for the next page.

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.