candle

Subscribe to candle

post

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

/

Subscription to candlestick events for a specific asset and time interval.

Body

application/json

Subscription to candlestick events for a specific asset and time interval.

typeundefined · enumRequired

Type of subscription.

Possible values:

coinstringRequired

Asset symbol (e.g., BTC).

intervalundefined · enumRequired

Time interval.

Possible values:

Responses

200

Event of candlestick data point.

application/json

Event of candlestick data point.

tnumberRequired

Opening timestamp (ms since epoch).

TnumberRequired

Closing timestamp (ms since epoch).

sstringRequired

Asset symbol.

istring · enumRequired

Time interval.

Possible values:

ostringRequired

Opening price.

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

cstringRequired

Closing price.

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

hstringRequired

Highest price.

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

lstringRequired

Lowest price.

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

vstringRequired

Total volume traded in base currency.

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

nnumberRequired

Number of trades executed.

post

/

TypeScript

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

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

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

200

Event of candlestick data point.

{
  "t": 1,
  "T": 1,
  "s": "text",
  "i": "1m",
  "o": "text",
  "c": "text",
  "h": "text",
  "l": "text",
  "v": "text",
  "n": 1
}