/hypercore JSON-RPC methods requires a Build plan or higher. View pricing to upgrade. For complete stream type definitions and filtering options, see the datasets documentation. This method efficiently retrieves clearinghouse states for up to 1000 users in a single request. The response includes both successful states and any failed wallet addresses. Use the optional dex parameter with value "ALL_DEXES" to retrieve data across all DEXes (native, xyz, flx, vntl, hyna, km, abcd, cash, para, mkts, io). To get spot balances and account mode in the same request, see the multi-wallet balance queries guide.Parameters
- usersarrayREQUIRED
Array of Ethereum wallet addresses (0x-prefixed, 42 characters each). Maximum 1000 addresses
- dexstring
Optional. Omit for native DEX only, or use 'ALL_DEXES' to fetch data across all DEXes. When using ALL_DEXES, each clearinghouse state will be organized by DEX name (native, xyz, flx, vntl, hyna, km, abcd, cash, para, mkts, io)
Returns
- resultobject
Batch response containing successful states and failed wallets
- successful_statesarray
Array of [address, data] tuples. When dex parameter is omitted: data is a clearinghouseState object. When dex='ALL_DEXES': data is an object keyed by DEX names (native, xyz, flx, vntl, hyna, km, abcd, cash, para, mkts, io), where each value is a clearinghouseState object
- addressstring
Ethereum wallet address (0x-prefixed)
- dataobject
Clearinghouse state data. Structure depends on dex parameter. Each clearinghouse state contains the following fields
- marginSummaryobject
Summary of margin metrics
- accountValuestring
Total account value as a stringified number
- totalMarginUsedstring
Total margin used across all positions as a stringified number
- totalNtlPosstring
Total notional position value as a stringified number
- totalRawUsdstring
Total raw USD value as a stringified number
- crossMarginSummaryobject
Summary of cross-margin metrics with identical structure to marginSummary
- crossMaintenanceMarginUsedstring
Cross maintenance margin used as a stringified number
- withdrawablestring
Amount available for withdrawal as a stringified number
- assetPositionsarray
Array of position objects for each asset
- positionobject
Individual asset position data
- coinstring
Asset symbol (e.g., BTC, ETH)
- entryPxstring
Entry price as a stringified number
- leverageobject
Leverage settings for the position
- liquidationPxstring
Liquidation price as a stringified number
- marginUsedstring
Margin used for this position as a stringified number
- unrealizedPnlstring
Unrealized profit and loss as a stringified number
- timeinteger
Timestamp in milliseconds since Unix epoch
- failed_walletsarray
Array of wallet addresses that could not be fetched
- addressstring
Ethereum wallet address that failed (0x-prefixed)