/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 consolidates clearinghouse states, spot balances, and account abstraction modes for up to 500 users in a single request. The response includes both successful portfolio 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). Credits are charged dynamically based on the number of users in the request. For a full walkthrough with curl, TypeScript, and SQL Explorer, see the multi-wallet balance queries guide.Parameters
- usersarrayREQUIRED
Array of Ethereum wallet addresses (0x-prefixed, 42 characters each). Maximum 500 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 portfolio states and failed wallets
- successful_statesarray
Array of [address, data] tuples. When dex parameter is omitted: data is a portfolioState object. When dex='ALL_DEXES': data is an object where clearinghouseState is keyed by DEX names (native, xyz, flx, vntl, hyna, km, abcd, cash, para, mkts, io), with each value being a clearinghouseState object
- addressstring
Ethereum wallet address (0x-prefixed)
- dataobject
Portfolio state data. Structure depends on dex parameter
- clearinghouseStateobject
When dex parameter is omitted: a single clearinghouse state object. When dex='ALL_DEXES': an object keyed by DEX names (native, xyz, flx, vntl, hyna, km, abcd, cash, para, mkts, io), where each value is a clearinghouse state object
- 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
- withdrawablestring
Amount available for withdrawal as a stringified number
- crossMarginSummaryobject
Summary of cross-margin metrics with identical structure to marginSummary
- 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
- spotClearinghouseStateobject
Spot clearinghouse state containing balances and available amounts after maintenance
- balancesarray
Array of spot balance objects
- coinstring
Coin symbol
- tokeninteger
Token index
- totalstring
Total balance as a stringified number
- holdstring
Amount on hold as a stringified number
- entryNtlstring
Entry notional as a stringified number
- tokenToAvailableAfterMaintenancearray
Array of [token_index, available_amount] tuples showing available balance after maintenance requirements for each token
- userAbstractionstring
Account mode: unifiedAccount, portfolioMargin, disabled, default, or dexAbstraction
- failed_walletsarray
Array of wallet addresses that could not be fetched
- addressstring
Ethereum wallet address that failed (0x-prefixed)