Skip to main content

types.ChartCandle#

Per-bar OHLCV record.

SYNTAX#

interface ChartCandle { time: number; open: number; high: number; low: number; close: number; volume: number; }

ARGUMENTS#

  • time (number) — Unix epoch in SECONDS. Producers convert API millisecond timestamps via ms / 1000 before storage.
  • open (number) — Open price.
  • high (number) — High price.
  • low (number) — Low price.
  • close (number) — Close price.
  • volume (number) — Bar volume in base-asset units.

RETURNS#

Type definition.

EXAMPLE#

function onBar(i, ctx) {
  const c = candles[i];
  // typical price
  const tp = (c.high + c.low + c.close) / 3;
  plot('tp', tp);
}

SEE ALSO#

data.candles, data.source