Error
A valid request URL is required to generate request examples{
"version": "external-candles/v1",
"marketId": "<string>",
"series": "trade",
"timeframe": "1m",
"fromEpochMs": 1,
"toEpochMs": 1,
"snapshotSequence": 1,
"candles": [
{
"bucketStartEpochMs": 1,
"open": "<string>",
"high": "<string>",
"low": "<string>",
"close": "<string>",
"volume": "<string>",
"source": "trade"
}
],
"gaps": [
{
"fromEpochMs": 1,
"toEpochMs": 1
}
],
"resync": {
"stream": "market.candles",
"fromSequence": 123
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}Markets
Get index candles
Returns index-price candles for a market over the requested window.
Method and path: GET /v1/markets//candles
Authentication: none.
Request schema: none.
Response schema: ExternalCandlesResponse.
Error envelope: ExternalRestError (external-rest-error/v1).
GET
/
v1
/
markets
/
{marketId}
/
candles
Error
A valid request URL is required to generate request examples{
"version": "external-candles/v1",
"marketId": "<string>",
"series": "trade",
"timeframe": "1m",
"fromEpochMs": 1,
"toEpochMs": 1,
"snapshotSequence": 1,
"candles": [
{
"bucketStartEpochMs": 1,
"open": "<string>",
"high": "<string>",
"low": "<string>",
"close": "<string>",
"volume": "<string>",
"source": "trade"
}
],
"gaps": [
{
"fromEpochMs": 1,
"toEpochMs": 1
}
],
"resync": {
"stream": "market.candles",
"fromSequence": 123
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}Path Parameters
Minimum string length:
1Query Parameters
Candle source series. Defaults to index.
Available options:
trade, index, mark Candle timeframe. Defaults to 1m.
Available options:
1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 8h, 12h, 1d, 3d, 1w, 1M Optional inclusive epoch-millisecond range start.
Optional inclusive epoch-millisecond range end.
Response
Success
Allowed value:
"external-candles/v1"Minimum string length:
1Available options:
trade, index, mark Available options:
1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 8h, 12h, 1d, 3d, 1w, 1M Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes