spotState

Subscribe to spotState

post

wss://api.hyperliquid.xyz/wswss://api.hyperliquid-testnet.xyz/ws

/

Subscription to spot state events for a specific user.

Body

application/json

Subscription to spot state events for a specific user.

typeundefined · enumRequired

Type of subscription.

Possible values:

userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

ignorePortfolioMarginbooleanOptional

Whether to ignore portfolio margin calculations.

Responses

200

Event of user spot state.

application/json

post

/

HTTPcURLJavaScriptPython

POST /ws/ HTTP/1.1
Host: wss://api.hyperliquid.xyz
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "type": "spotState",
  "user": "text",
  "ignorePortfolioMargin": true
}

200

Event of user spot state.

{
  "user": "text",
  "spotState": {
    "balances": [
      {
        "coin": "text",
        "token": 1,
        "total": "text",
        "hold": "text",
        "entryNtl": "text"
      }
    ],
    "evmEscrows": [
      {
        "coin": "text",
        "token": 1,
        "total": "text"
      }
    ]
  }
}