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 · nullableOptional

Number of significant figures.

Possible values:

mantissaany ofOptional

Mantissa for aggregation (if nSigFigs is 5).

undefined · enum · nullableOptional

Mantissa for aggregation (if nSigFigs is 5).

Possible values:

Responses

200

Event of L2 order book snapshot.

application/json

Event of L2 order book snapshot.

coinstringRequired

Asset symbol.

timenumberRequired

Timestamp of the snapshot (in ms since epoch).

spreadstringOptional

Spread (only present when nSigFigs is non-null).

Pattern: ^[0-9]+(\.[0-9]+)?$

post

/

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.WebSocketTransport();
const client = new hl.SubscriptionClient({ transport });

const sub = await client.l2Book({ coin: "ETH" }, (data) => {
  console.log(data);
});

200

Event of L2 order book snapshot.

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