Interface ApiPerpetualsMarketCandleHistoryBody

Request payload for fetching historical candle (OHLCV) data for a given perpetuals market.

interface ApiPerpetualsMarketCandleHistoryBody {
    fromTimestamp: number;
    marketId: string;
    resolution: PerpetualsCandleResolution;
    toTimestamp: number;
}

Properties

fromTimestamp: number

Start of the time range to query, as a Unix timestamp in milliseconds.

marketId: string

Identifier of the perpetuals market whose candles you want to fetch.

Must be a valid on-chain market ID.

Candle resolution as a CCXT-style timeframe label (e.g. "1m", "1h", "1d").

toTimestamp: number

End of the time range to query, as a Unix timestamp in milliseconds.