l2Book

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request L2 order book.

Body

application/json

Request L2 order book.

typeundefined · enumRequired

Type of request.

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

L2 order book snapshot or null if the market does not exist.

application/json

L2 order book snapshot or null if the market does not exist.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

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

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.l2Book({ coin: "ETH", nSigFigs: 2 });

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