l2Book

Subscribe to l2Book

post

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

/

Subscription to L2 order book events for a specific asset.

Body

application/json

Subscription to L2 order book events for a specific asset.

typeundefined · enumRequired

Type of subscription.

Possible values:

coinstringRequired

Asset symbol (e.g., BTC).

nSigFigsany ofOptional

Number of significant figures.

undefined · enum | nullableOptionalPossible values:

mantissaany ofOptional

Mantissa for aggregation (if nSigFigs is 5).

undefined · enum | nullableOptionalPossible values:

Responses

200

Event of L2 order book snapshot.

application/json

post

/

HTTPcURLJavaScriptPython

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

{
  "type": "l2Book",
  "coin": "text",
  "nSigFigs": 2,
  "mantissa": 2
}

200

Event of L2 order book snapshot.

{
  "coin": "text",
  "time": 1,
  "levels": []
}