Skip to main content
GET
/
candles
Get candles
curl --request GET \
  --url https://perp-api.phoenix.trade/candles
[
  {
    "close": 123,
    "high": 123,
    "low": 123,
    "open": 123,
    "time": 123,
    "externalSource": "<string>",
    "markClose": 123,
    "markHigh": 123,
    "markLow": 123,
    "markOpen": 123,
    "tradeCount": 1,
    "volume": 123,
    "volumeQuote": 123
  }
]

Query Parameters

​
symbol
string
required
​
timeframe
string
required
​
startTime
integer<int64>
​
endTime
integer<int64>
​
limit
integer<int64>
​
enableExternalSource
boolean

Response

200 - application/json

Candles

​
close
number<double>
required
​
high
number<double>
required
​
low
number<double>
required
​
open
number<double>
required
​
time
integer<int64>
required

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

​
externalSource
string | null

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

​
markClose
number<double>
​
markHigh
number<double>
​
markLow
number<double>
​
markOpen
number<double>
​
tradeCount
integer<int64> | null
Required range: x >= 0
​
volume
number<double> | null
​
volumeQuote
number<double> | null

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