candleSnapshot

post

/info

Request candlestick snapshots.

Body

Request candlestick snapshots.

typeundefined · enumRequired

Type of request.

Possible values:

Responses

200

Array of candlestick data points.

application/json

Array of candlestick data points.

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.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

PreviousborrowLendUserState NextclearinghouseState

Last updated 14 days ago

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

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

const data = await client.candleSnapshot({
  coin: "ETH",
  interval: "1h",
  startTime: Date.now() - 1000 * 60 * 60 * 24,
});