PHphoenix
Exchange

Get candles

Handles GET /v1/candles/{symbol} via get.v1.candles.by_symbol.

get/v1/candles/{symbol}

Request

Path parameters

symbolstring required

Trading symbol

Query parameters

timeframestring required

Timeframe

startTimeinteger

Start time in milliseconds since Unix epoch

endTimeinteger

End time in milliseconds since Unix epoch

limitinteger

Max number of candles (default: 2500)

enableExternalSourceboolean

Opt-in external candles stored in the DB (default: false)

Response

Asset candles

closenumber double required
externalSourcestring nullable

External candle source name (e.g., "binance", "coinbase"). Omitted from JSON for exchange candles to preserve backward compatibility.

highnumber double required
lownumber double required
markClosenumber double
markHighnumber double
markLownumber double
markOpennumber double
opennumber double required
timeinteger required

Candle timestamp as a Unix timestamp in milliseconds (UTC).

tradeCountinteger nullable
volumenumber double nullable
volumeQuotenumber double nullable

Quote currency volume (e.g. USDC) for the candle period.

Changes

No recorded changes to this operation across all 2 revisions of this API.