Skip to main content
POST
/
4f8d8f4040bdacd1577bff8058438274
/
info
info (spotClearinghouseState)
curl --request POST \
  --url https://hyperliquid-mainnet.core.chainstack.com/4f8d8f4040bdacd1577bff8058438274/info \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "spotClearinghouseState",
  "user": "0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036"
}'
{
  "balances": [
    {
      "coin": "<string>",
      "token": 123,
      "hold": "<string>",
      "total": "<string>",
      "entryNtl": "<string>"
    }
  ]
}
The info endpoint with type: "spotClearinghouseState" retrieves a user’s token balances for spot trading on the Hyperliquid exchange. This endpoint provides detailed information about available balances, held amounts in open orders, and entry notional values for all spot tokens in the user’s account.
Get your own node endpoint todayStart for free and get your app to production levels immediately. No credit card required.You can sign up with your GitHub, X, Google, or Microsoft account.

​
Parameters

​
Request body

  • type (string, required) — The request type. Must be "spotClearinghouseState" to retrieve user’s spot token balances.
  • user (string, required) — Onchain address in 42-character hexadecimal format (e.g., 0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036).

​
Response

The response contains detailed balance information:

​
Balances

An array of the user’s spot token balances:
  • coin (string) — Token symbol (e.g., “USDC”, “PURR”).
  • token (integer) — Token index identifier used internally by the exchange.
  • hold (string) — Amount currently on hold (locked in open orders or pending transactions).
  • total (string) — Total balance including both available and held amounts.
  • entryNtl (string) — Entry notional value, used for PnL calculations and tracking cost basis.

​
Balance calculation

The available balance for trading can be calculated as: 
Available Balance = Total - Hold
For example, if total is “14.625485” and hold is “0.0”, then the available balance is “14.625485”.

​
Example request

Shell
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"type": "spotClearinghouseState", "user": "0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036"}' \
  https://hyperliquid-mainnet.core.chainstack.com/4f8d8f4040bdacd1577bff8058438274/info

​
Use case

The info endpoint with type: "spotClearinghouseState" is essential for spot trading applications that need to:
  • Display user’s current spot token balances
  • Calculate available balance for new orders (total - hold)
  • Show which tokens are locked in open orders
  • Track cost basis and entry values for portfolio management
  • Validate order placement against available balances
  • Build trading interfaces with real-time balance updates
  • Implement portfolio tracking and PnL calculations
This endpoint is typically called frequently to keep trading interfaces updated with current balance information and ensure accurate order placement validation.

Body

application/json
​
type
enum<string>
default:spotClearinghouseState
required

Request type to retrieve user's spot token balances

Available options:
spotClearinghouseState
​
user
string
default:0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036
required

Onchain address in 42-character hexadecimal format

Response

200 - application/json

User's spot token balances

​
balances
object[]
required

Array of user's spot token balances