clearinghouseState

Subscribe to clearinghouseState

post

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

/

Subscription to clearinghouse state events for a specific user.

Body

application/json

Subscription to clearinghouse 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]+$

dexstringOptional

DEX name (empty string for main dex).

Responses

200

Event of clearinghouse state for a specific user.

application/json

post

/

HTTPcURLJavaScriptPython

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

{
  "type": "clearinghouseState",
  "user": "text",
  "dex": "text"
}

200

Event of clearinghouse state for a specific user.

{
  "dex": "text",
  "user": "text",
  "clearinghouseState": {
    "marginSummary": {
      "accountValue": "text",
      "totalNtlPos": "text",
      "totalRawUsd": "text",
      "totalMarginUsed": "text"
    },
    "crossMarginSummary": {
      "accountValue": "text",
      "totalNtlPos": "text",
      "totalRawUsd": "text",
      "totalMarginUsed": "text"
    },
    "crossMaintenanceMarginUsed": "text",
    "withdrawable": "text",
    "assetPositions": [
      {
        "type": "oneWay",
        "position": {
          "coin": "text",
          "szi": "text",
          "leverage": {
            "type": "isolated",
            "value": 1,
            "rawUsd": "text"
          },
          "entryPx": "text",
          "positionValue": "text",
          "unrealizedPnl": "text",
          "returnOnEquity": "text",
          "liquidationPx": "text",
          "marginUsed": "text",
          "maxLeverage": 1,
          "cumFunding": {
            "allTime": "text",
            "sinceOpen": "text",
            "sinceChange": "text"
          }
        }
      }
    ],
    "time": 1
  }
}