info
endpoint with type: "clearinghouseState"
retrieves a user’s perpetuals account summary including open positions and margin information for the Hyperliquid exchange. This endpoint provides comprehensive data about a user’s trading positions, leverage, margin usage, and account value.
type
(string, required) — The request type. Must be "clearinghouseState"
to retrieve user’s account summary.user
(string, required) — Onchain address in 42-character hexadecimal format (e.g., 0x31ca8395cf837de08b24da3f660e77761dfb974b
).dex
(string, optional) — Perp dex name. Defaults to the empty string which represents the first perp dex.assetPositions
(array) — Array of the user’s current asset positions.crossMaintenanceMarginUsed
(string) — Cross maintenance margin used.crossMarginSummary
(object) — Cross margin account summary.marginSummary
(object) — Overall margin summary.time
(number) — Timestamp of the data.withdrawable
(string) — Amount available for withdrawal.assetPositions
array contains:
position
(object) — Position details:
coin
(string) — Asset symbol (e.g., “ETH”, “BTC”).cumFunding
(object) — Cumulative funding information:
allTime
(string) — All-time cumulative funding.sinceChange
(string) — Funding since last position change.sinceOpen
(string) — Funding since position opened.entryPx
(string) — Entry price of the position.leverage
(object) — Leverage information:
rawUsd
(string) — Raw USD value.type
(string) — Leverage type (“isolated” or “cross”).value
(number) — Leverage multiplier.liquidationPx
(string) — Price at which position would be liquidated.marginUsed
(string) — Margin used for this position.maxLeverage
(number) — Maximum leverage allowed for this asset.positionValue
(string) — Current value of the position.returnOnEquity
(string) — Return on equity percentage.szi
(string) — Position size.unrealizedPnl
(string) — Unrealized profit and loss.type
(string) — Position type (e.g., “oneWay”).crossMarginSummary
and marginSummary
contain:
accountValue
(string) — Total account value.totalMarginUsed
(string) — Total margin used.totalNtlPos
(string) — Total notional position.totalRawUsd
(string) — Total raw USD.info
endpoint with type: "clearinghouseState"
is essential for perpetuals trading applications that need to:
User's perpetuals account summary including positions and margin information
The response is of type object
.