Candles
Data feed of the candles of a market. Data contains updates for open, low, high, and close prices, trade volume, for a certain time resolution.
Method Declaration
Python
# class `Candles`
def subscribe(self, id: str, resolution: CandlesResolution, batched: bool = True) -> Self
def unsubscribe(self, id: str, resolution: CandlesResolution)Schema
The field id is a string containing the market and candle resolution. It is formatted as {market}/{resolution}. For a spot market the market is prefixed with SPOT: (e.g. SPOT:MARTI-USDC/1MIN); a bare ticker is a perpetual market.
The field contents is serialized using the following schemas.
Messages
| Initial | Update |
|---|---|
CandlesInitialMessage | CandlesUpdateMessage * |