Skip to main content
POST
crypto.hyperliquid.positions

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
address
string
required

Wallet address: a 0x EVM address or an ENS name (e.g. vitalik.eth). Solana addresses are not supported.

Required string length: 1 - 512
dex
enum<string>

Market scope: omit (or main_dex) for the native market, or a builder market — one of: xyz, flx, vntl, hyna, km, abcd, cash, para, mkts.

Available options:
main_dex,
xyz,
flx,
vntl,
hyna,
km,
abcd,
cash,
para,
mkts

Response

The result

accountValue
number
required

Account value.

positions
object[]

Positions.

crossMaintenanceMarginUsed
number

Cross maintenance margin used.

marginRatio
number

Margin ratio.

timestamp
number

Timestamp.

totalMarginUsed
number

Total margin used.

totalNotionalPos
number

Total notional pos.

totalRawUsd
number

Total raw usd.

withdrawable
number

Withdrawable.

address
string

Address.