Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

market
string

One market. Leave it out for all markets.

max_distance_pct
enum<string>
default:5

Largest distance to liquidation, in percent. The options match the choices on hyperdash.com.

Available options:
1,
2,
5,
10
min_notional
enum<string>
default:0

Smallest position notional in USD. 0 means any size, which is the default on hyperdash.com.

Available options:
0,
100000,
1000000
limit
integer
default:50

Rows to return, at most 100.

Required range: 1 <= x <= 100

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.