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

Perp market, for example BTC or xyz:TSLA.

Query Parameters

side
enum<string>
default:all

Position side.

Available options:
all,
long,
short
sort
enum<string>
default:notional

Field to sort by.

Available options:
notional,
entry_px,
liquidation_px,
unrealized_pnl,
funding_pnl,
account_value,
address
order
enum<string>
default:desc

Sort order. Use asc for A to Z addresses.

Available options:
desc,
asc
min_notional
string

Minimum notional at mark in USD, inclusive.

max_notional
string

Maximum notional at mark in USD, inclusive.

min_entry_px
string

Minimum entry price, inclusive.

max_entry_px
string

Maximum entry price, inclusive.

min_liquidation_px
string

Minimum liquidation price, inclusive.

max_liquidation_px
string

Maximum liquidation price, inclusive.

min_unrealized_pnl
string

Minimum unrealized PnL in USD, inclusive.

max_unrealized_pnl
string

Maximum unrealized PnL in USD, inclusive.

min_account_value
string

Minimum account value in USD, inclusive.

max_account_value
string

Maximum account value in USD, inclusive.

limit
integer
default:100

Rows per page.

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