Skip to main content
GET
/
v1
/
candles
curl
curl "https://api.testnet.arcus.xyz/v1/candles?market=BTC-USD&timeframe=1m&to=1700000000000000&countback=200"
{
  "candles": [
    {
      "marketDisplayName": "<string>",
      "marketId": 32767,
      "timeframe": "1m",
      "openTime": 1712345640000000,
      "open": "94500.00",
      "high": "94510.00",
      "low": "94490.00",
      "close": "94505.00",
      "volume": "12.34",
      "takerBuyVolume": "7.50",
      "notionalVolume": "1165170.00",
      "takerBuyNotionalVolume": "708450.00",
      "tradeCount": 42,
      "isFinal": false
    }
  ]
}

Query Parameters

​
market
string
required

Market identifier, e.g. "BTC-USD".

Example:

"BTC-USD"

​
timeframe
enum<string>
required

Candle interval.

Available options:
1m,
3m,
5m,
15m,
30m,
1h,
2h,
4h,
8h,
12h,
1d,
3d,
1w
Example:

"1m"

​
to
integer<int64>
required

Upper bound of the requested window, expressed as a Unix timestamp in microseconds. The returned bars cover the half-open interval [from, to) or the countback bars ending at this point. Seconds- or milliseconds-scale values are rejected.

Example:

1700000000000000

​
from
integer<int64>

Lower bound of the requested window in Unix microseconds. Mutually exclusive with countback; if both are omitted the most recent bars up to to are returned (up to the server maximum).

Example:

1699900000000000

​
countback
integer

Number of closed bars to return, counting backwards from to. Mutually exclusive with from; if both are omitted the server returns the most recent bars ending at to. Values above 1500 are clamped to the server maximum.

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

200

Response

Candle bars, oldest-first.

​
candles
object[]
required