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

One OHLCV candle from the indexer. Keys are camelCase (indexer wire shape).

Definition

class PerpsCandle(TypedDict):
    pairId: str
    interval: str
    minBlockHeight: int
    maxBlockHeight: int
    open: str
    high: str
    low: str
    close: str
    volume: str
    volumeUsd: str
    timeStart: str
    timeStartUnix: int
    timeEnd: str
    timeEndUnix: int

Fields

pairIdstr.

intervalstr. The wire form of CandleInterval (e.g. "ONE_MINUTE").

open/high/low/closestr. 6-decimal BigDecimal strings.

volumestr. Base-asset volume.

volumeUsdstr. Quote-asset (USD) volume.

timeStart/timeEndstr. ISO-8601 datetime strings.

timeStartUnix/timeEndUnixint. Unix milliseconds (despite the Unix suffix).

See also