Messages

{
  "type": "subscribed",
  "channel": "candles",
  "id": "BTC-USD/1m",
  "contents": {
    "isSnapshot": true,
    "candles": [
      {
        "open": "94000.00",
        "high": "94800.00",
        "low": "93500.00",
        "close": "94500.00",
        "volume": "123.45",
        "openTime": 1712345580000000,
        "isFinal": true
      },
      {
        "open": "94500.00",
        "high": "94600.00",
        "low": "94400.00",
        "close": "94550.00",
        "volume": "45.2",
        "openTime": 1712345640000000,
        "isFinal": false
      }
    ]
  }
}

Market data

Candles

Endpoint: wss://api.testnet.arcus.xyz/v1/ws — one socket multiplexes every channel and RPC request. Click Connect, then send the example subscribe message below to start receiving data.

OHLCV candlestick stream. Subscribe id is "MARKET/TIMEFRAME", e.g. "BTC-USD/1m".

On subscribe: snapshot of the most recent candles (up to 200). Then: real-time updates as each bar changes. Open-candle updates are coalesced and sent at most about every 250 ms per market/timeframe. isFinal: true updates are sent immediately when the interval closes and the bar will not be updated again.

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

WSS

ws?channel=candles

Messages

{
  "type": "subscribed",
  "channel": "candles",
  "id": "BTC-USD/1m",
  "contents": {
    "isSnapshot": true,
    "candles": [
      {
        "open": "94000.00",
        "high": "94800.00",
        "low": "93500.00",
        "close": "94500.00",
        "volume": "123.45",
        "openTime": 1712345580000000,
        "isFinal": true
      },
      {
        "open": "94500.00",
        "high": "94600.00",
        "low": "94400.00",
        "close": "94550.00",
        "volume": "45.2",
        "openTime": 1712345640000000,
        "isFinal": false
      }
    ]
  }
}

Subscribe to candles

type:object

Candles Snapshot

Candle Update

type:object

A single candle bar update. Same shape as Candle in openapi.yaml. Open-candle updates are coalesced to at most about every 250 ms per market/timeframe. isFinal: true when the bar interval has closed; final updates are sent immediately.

Exchange attribute updates Account