Skip to main content
POST
crypto.hyperliquid.trade-context

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
closeTime
integer
required

Episode close time, Unix seconds, copied from GET /hyperliquid/trades.

Required range: 0 <= x <= 1000000
direction
enum<string>
required

Opening direction of the episode.

Available options:
long,
short
openTime
integer
required

Episode open time, Unix seconds, copied from GET /hyperliquid/trades.

Required range: 0 <= x <= 1000000
symbol
string
required

Hyperliquid perpetual market id, including a builder prefix for HIP-3 markets (for example xyz:GOLD).

Required string length: 1 - 512

Response

The result

fundingStatus
string
required

Funding status.

fundingPnl
number

Funding pnl.

leverage
number

Leverage.

reportedLeverage
number

Reported leverage.

leverageSemantics
string

Leverage semantics.

leverageType
string

Leverage type.

reportedLeverageType
string

Reported leverage type.