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
Parameter | Location | Type | Required | Description |
---|---|---|---|---|
market | path | Ticker | true | The market ticker. |
resolution | query | CandleResolution | true | The candle resolution (e.g., "1DAY", "1HOUR", "1MIN"). |
limit | query | u32 | false | The maximum number of candles to retrieve. |
fromIso | query | DateTime | false | The start timestamp in ISO format. |
toIso | query | DateTime | false | The end timestamp in ISO format. |
Response
Status | Meaning | Schema | Description |
---|---|---|---|
200 | OK | CandleResponseObject ⛁ | The candle data. |
400 | Bad Request | The request was malformed or invalid. |
API Example