webData3

Subscribe to webData3

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": "webData3",
  "user": "text"
}

200

Comprehensive user and market data.

{
  "userState": {
    "agentAddress": "text",
    "agentValidUntil": 1,
    "cumLedger": "text",
    "serverTime": 1,
    "isVault": true,
    "user": "text",
    "optOutOfSpotDusting": true,
    "dexAbstractionEnabled": true
  },
  "perpDexStates": [
    {
      "totalVaultEquity": "text",
      "perpsAtOpenInterestCap": [
        "text"
      ],
      "leadingVaults": [
        {
          "address": "text",
          "name": "text"
        }
      ]
    }
  ]
}