Market Candles - Edel Developer Docs

market.candles is a public market-scoped channel. Authentication: none. Payload schema: RealtimeMarketCandlePayload. Source status: live. Send this exact JSON shape. requestId is required and there is no action field. The series field is required and accepts trade, index, mark.

{
  "version": "realtime-subscribe/v1",
  "requestId": "subscribe-market-candles",
  "channel": "market.candles",
  "series": "trade",
  "marketId": "BTC-USD"
}

Accepted frame

The subscription is active only after a matching realtime-subscription-accepted/v1 frame arrives.

{
  "version": "realtime-subscription-accepted/v1",
  "requestId": "subscribe-market-candles",
  "channel": "market.candles",
  "series": "trade",
  "visibility": "public",
  "marketId": "BTC-USD",
  "nextSequence": 1,
  "heartbeatIntervalMs": 10000,
  "replay": {
    "mode": "latest",
    "gapErrorCode": "sequence_gap",
    "resyncErrorCode": "resync_required"
  }
}

Data frame

The envelope is realtime-stream/v1; its payload validates against RealtimeMarketCandlePayload.

{
  "version": "realtime-stream/v1",
  "messageId": "messageid-example",
  "type": "data",
  "channel": "market.candles",
  "sequence": 1,
  "occurredAtEpochMs": 1,
  "visibility": "public",
  "marketId": "BTC-USD",
  "checkpoint": {
    "kind": "system"
  },
  "payload": {
    "marketId": "BTC-USD",
    "series": "trade",
    "timeframe": "1m",
    "bucketStartEpochMs": 0,
    "open": "open-example",
    "high": "high-example",
    "low": "low-example",
    "close": "close-example",
    "volume": "volume-example",
    "source": "trade"
  }
}

Worked example

Send the subscribe envelope with request id subscribe-market-candles.
Wait for the accepted frame with the same request id; receiving any other frame does not prove this subscription.
Process the data frame at sequence 1 and validate its payload as RealtimeMarketCandlePayload.