Skip to main content
GET
curl
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns OHLCV candlestick bars for an api-meta spot/equity market, aggregated at query time from a backfilled 1-minute dataset. Public — no X-API-Key and no signature required. Only mounted on deployments where the candles sub-feature is enabled; absent otherwise. Charting-library request schema using the platform’s market / timeframe parameter names. Differences from the platform GET /v1/candles:
  • market is the underlying’s ticker symbol (AAPL) — the same key GET /v1/api-meta/markets uses, not a arcus market name.
  • from / to are unix seconds (not milliseconds); millisecond timestamps are rejected with a 400.
  • countback, when present, is authoritative: exactly that many bars ending at to, and from is treated as a hint (ignored). Without countback, from is required. Either way the response is capped at 1500 bars.
  • Bars are returned newest-first; isFinal is false on the still-accumulating bucket.
  • No gap fill: buckets outside market hours are absent rather than forward-filled flat bars.

Query Parameters

market
string
required

Ticker symbol of the underlying, e.g. "AAPL".

Example:

"AAPL"

timeframe
string
required

Bucket width, passed through as-is: platform tokens (1m 3m 5m 15m 30m 1h 2h 4h 8h 12h 1d 3d 1w), bare minutes (1, 60, 240), or D/1D/W/1W. Months are not supported.

Example:

"5m"

from
integer<int64>

Window start, unix seconds (not millis). Required unless countback is present, in which case it is a hint and ignored. The bar containing from is included. Values of 1e11 or more (millisecond-scale) are rejected.

Required range: x >= 1
Example:

1776000000

to
integer<int64>
required

Window end, unix seconds (not millis). The bar containing to is the newest returned. Values of 1e11 or more (millisecond-scale) are rejected.

Required range: x >= 1
Example:

1776600000

countback
integer

When present it is authoritative: exactly this many bars ending at to (capped at 1500), and from is ignored.

Required range: 1 <= x <= 1500
Example:

300

Response

Spot candle bars, newest-first.

candles
object[]
required

OHLCV bars, newest-first.