bbo

Subscribe to bbo

post

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

/

Subscription to best bid and offer events for a specific asset.

Body

application/json

Subscription to best bid and offer events for a specific asset.

typeundefined · enumRequired

Type of subscription.

Possible values:

coinstringRequired

Asset symbol (e.g., BTC).

Responses

200

Event of best bid and offer.

application/json

Event of best bid and offer.

coinstringRequired

Asset symbol (e.g., BTC).

timenumberRequired

Time of the BBO update (in ms since epoch).

post

/

TypeScript

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

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

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

200

Event of best bid and offer.

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