Skip to main content

Candle

type Candle = {
  close: number;
  high: number;
  low: number;
  open: number;
  timeMs: number;
  volume: number;
};

Source: types/src/index.ts:8

A single OHLCV bar. candles is an array of these.

Properties​

close​

close: number;

Source: types/src/index.ts:18

Closing price.

high​

high: number;

Source: types/src/index.ts:14

Highest price during the bar.

low​

low: number;

Source: types/src/index.ts:16

Lowest price during the bar.

open​

open: number;

Source: types/src/index.ts:12

Opening price.

timeMs​

timeMs: number;

Source: types/src/index.ts:10

Bar open time as Unix epoch milliseconds.

volume​

volume: number;

Source: types/src/index.ts:20

Traded volume during the bar.