Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

hdk_sk_live_v1_… or hdk_sk_test_v1_…

Headers

X-Max-Credits
integer

Refuse (free) if the request could cost more.

X-Credit-Price-Version
integer

Expected price version; 409 price_changed if it differs.

Path Parameters

coin
string
required

Perp market, e.g. BTC, xyz:TSLA.

Pattern: ^[A-Za-z0-9:_\-/@.]{1,40}$

Query Parameters

side
enum<string>
default:all

Position side.

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

Sort field.

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

Sort order.

Available options:
desc,
asc
limit
integer
default:100

Rows per page.

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

Opaque cursor from next_cursor.

Response

OK

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
meta
object
required