Skip to content

Get Candles

Retrieves candle data for a specific perpetual market.

Method Declaration

Python
async def get_perpetual_market_candles(
    self,
    market: str,
    resolution: str,
    from_iso: Optional[str] = None,
    to_iso: Optional[str] = None,
    limit: Optional[int] = None,
) -> dict
Unification Plan

Parameters

ParameterLocationTypeRequiredDescription
marketpathTickertrueThe market ticker.
resolutionqueryCandleResolutiontrueThe candle resolution (e.g., "1DAY", "1HOUR", "1MIN").
limitqueryu32falseThe maximum number of candles to retrieve.
fromIsoqueryDateTimefalseThe start timestamp in ISO format.
toIsoqueryDateTimefalseThe end timestamp in ISO format.

Response

StatusMeaningSchemaDescription
200OKCandleResponseObjectThe candle data.
400Bad RequestThe request was malformed or invalid.

API Example