This method returns one wallet per request. To query many wallets at once, see the multi-wallet balance queries guide.
Parameters
- typestringREQUIRED
The method type to call
- userstringREQUIRED
User address to query clearinghouse state for
- dexstring
The perp dex name. Defaults to the empty string which represents the first perp dex
Returns
- marginSummaryobject
Overall margin summary for the account
- accountValuestring
Total account value in USD
- totalNtlPosstring
Total notional position value
- totalRawUsdstring
Total raw USD value
- totalMarginUsedstring
Total margin currently used
- crossMarginSummaryobject
Cross margin summary for the account
- accountValuestring
Cross margin account value in USD
- totalNtlPosstring
Cross margin total notional position value
- totalRawUsdstring
Cross margin total raw USD value
- totalMarginUsedstring
Cross margin total margin used
- crossMaintenanceMarginUsedstring
Cross maintenance margin currently used
- withdrawablestring
Amount available for withdrawal
- assetPositionsarray
The list of open perpetual positions for the account. This is empty if no positions are held.
- typestring
The position mode, such as
oneWayorhedged
- positionobject
The details of the open position
- coinstring
The asset symbol of the position (e.g., BTC, ETH)
- szistring
The position size. Positive values indicate long positions, negative values indicate shorts
- leverageobject
The leverage configuration for the position
- typestring
The leverage type, such as
cross
- valueinteger
The applied leverage multiplier
- entryPxstring
The price at which the position was opened
- positionValuestring
The current notional value of the position
- unrealizedPnlstring
The unrealized profit or loss for this position
- returnOnEquitystring
The return on equity (ROE) for this position
- liquidationPxstring
The estimated liquidation price. May be null if not applicable (Optional)
- marginUsedstring
The margin allocated to maintain this position
- maxLeverageinteger
The maximum leverage allowed for this asset
- cumFundingobject
The cumulative funding payments applied to this position
- allTimestring
The total funding paid or received since inception
- sinceOpenstring
The funding accrued since the position was opened
- sinceChangestring
The funding accrued since the last leverage change
- timeinteger
Timestamp of the clearinghouse state