webData2

Subscribe to webData2

post

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

/

Subscription to comprehensive user and market data events.

Body

application/json

Subscription to comprehensive user and market data events.

typeundefined · enumRequired

Type of subscription.

Possible values:

userstring · min: 42 · max: 42Required

User address.

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

Responses

200

Comprehensive user and market data.

application/json

post

/

HTTPcURLJavaScriptPython

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

{
  "type": "webData2",
  "user": "text"
}

200

Comprehensive user and market data.

{
  "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
  },
  "leadingVaults": [
    {
      "address": "text",
      "name": "text"
    }
  ],
  "totalVaultEquity": "text",
  "openOrders": [
    {
      "coin": "text",
      "side": "B",
      "limitPx": "text",
      "sz": "text",
      "oid": 1,
      "timestamp": 1,
      "origSz": "text",
      "triggerCondition": "text",
      "isTrigger": true,
      "triggerPx": "text",
      "children": [],
      "isPositionTpsl": true,
      "reduceOnly": true,
      "orderType": "Market",
      "tif": "Gtc",
      "cloid": "text"
    }
  ],
  "agentAddress": "text",
  "agentValidUntil": 1,
  "cumLedger": "text",
  "meta": {
    "universe": [
      {
        "szDecimals": 1,
        "name": "text",
        "maxLeverage": 1,
        "marginTableId": 1,
        "onlyIsolated": true,
        "isDelisted": true,
        "marginMode": "strictIsolated",
        "growthMode": "enabled",
        "lastGrowthModeChangeTime": "text"
      }
    ],
    "marginTables": [
      []
    ],
    "collateralToken": 1
  },
  "assetCtxs": [
    {
      "prevDayPx": "text",
      "dayNtlVlm": "text",
      "markPx": "text",
      "midPx": "text",
      "funding": "text",
      "openInterest": "text",
      "premium": "text",
      "oraclePx": "text",
      "impactPxs": [
        "text"
      ],
      "dayBaseVlm": "text"
    }
  ],
  "serverTime": 1,
  "isVault": true,
  "user": "text",
  "twapStates": [
    []
  ],
  "spotState": {
    "balances": [
      {
        "coin": "text",
        "token": 1,
        "total": "text",
        "hold": "text",
        "entryNtl": "text"
      }
    ],
    "evmEscrows": [
      {
        "coin": "text",
        "token": 1,
        "total": "text"
      }
    ]
  },
  "spotAssetCtxs": [
    {
      "prevDayPx": "text",
      "dayNtlVlm": "text",
      "markPx": "text",
      "midPx": "text",
      "circulatingSupply": "text",
      "coin": "text",
      "totalSupply": "text",
      "dayBaseVlm": "text"
    }
  ],
  "optOutOfSpotDusting": true,
  "perpsAtOpenInterestCap": [
    "text"
  ]
}