Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

kind
enum<string>
default:cross

cross covers standard and unified accounts, which is every account that is not portfolio margin. coin_margined covers portfolio-margin accounts posting at least 1,000 USD of HYPE or BTC collateral. These match the XM and CM risk widgets on hyperdash.com.

Available options:
cross,
coin_margined
min_equity
string
default:100000

Minimum account equity in USD: cross books plus isolated margin and value.

min_leverage
string

Minimum cross leverage, which is cross notional divided by cross equity. Defaults to 3 for cross, because below 3x a plausible liquidation move is rare, and 0 for coin_margined.

sort
enum<string>
default:risk

risk puts the closest to liquidation first and accounts with no plausible move last. The other values sort largest first. Ties are ordered by address.

Available options:
risk,
equity,
notional,
leverage
limit
integer
default:100

Accounts per page.

Required range: 1 <= x <= 500

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.