Skip to main content

clearinghouseState Info Endpoint Method

Returns the clearinghouse state for a specific user including margin summary, account value, and asset positions.

Updated on
Oct 15, 2026

This method returns one wallet per request. To query many wallets at once, see the multi-wallet balance queries guide.

Parameters

type
string
REQUIRED

The method type to call

user
string
REQUIRED

User address to query clearinghouse state for

dex
string

The perp dex name. Defaults to the empty string which represents the first perp dex

Returns

marginSummary
object

Overall margin summary for the account

accountValue
string

Total account value in USD

totalNtlPos
string

Total notional position value

totalRawUsd
string

Total raw USD value

totalMarginUsed
string

Total margin currently used

crossMarginSummary
object

Cross margin summary for the account

accountValue
string

Cross margin account value in USD

totalNtlPos
string

Cross margin total notional position value

totalRawUsd
string

Cross margin total raw USD value

totalMarginUsed
string

Cross margin total margin used

crossMaintenanceMarginUsed
string

Cross maintenance margin currently used

withdrawable
string

Amount available for withdrawal

assetPositions
array

The list of open perpetual positions for the account. This is empty if no positions are held.

type
string

The position mode, such as oneWay or hedged

position
object

The details of the open position

coin
string

The asset symbol of the position (e.g., BTC, ETH)

szi
string

The position size. Positive values indicate long positions, negative values indicate shorts

leverage
object

The leverage configuration for the position

type
string

The leverage type, such as cross

value
integer

The applied leverage multiplier

entryPx
string

The price at which the position was opened

positionValue
string

The current notional value of the position

unrealizedPnl
string

The unrealized profit or loss for this position

returnOnEquity
string

The return on equity (ROE) for this position

liquidationPx
string

The estimated liquidation price. May be null if not applicable (Optional)

marginUsed
string

The margin allocated to maintain this position

maxLeverage
integer

The maximum leverage allowed for this asset

cumFunding
object

The cumulative funding payments applied to this position

allTime
string

The total funding paid or received since inception

sinceOpen
string

The funding accrued since the position was opened

sinceChange
string

The funding accrued since the last leverage change

time
integer

Timestamp of the clearinghouse state

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free