Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

PerpsCandle

An OHLC candle for a perps pair.

Definition

type PerpsCandle = {
  pairId: string
  interval: CandleIntervals
  minBlockHeight: number
  maxBlockHeight: number
  open: string
  high: string
  low: string
  close: string
  volume: string
  volumeUsd: string
  timeStart: string
  timeStartUnix: number
  timeEnd: string
  timeEndUnix: number
}

Fields

OHLC values are decimal strings. volume is in base asset; volumeUsd is the USD equivalent.

minBlockHeight and maxBlockHeight bracket the candle's block range.

See also