API reference
Fields & errors
OHLCV fields, HTTP error codes, and structured exception codes.
OHLCV response fields
Candle objects from
/price, /history, /candle and WebSocket frames share the same JSON shape.| Field | Type | Description |
|---|---|---|
| SymbolCode | string | Market symbol identifier, e.g. XAUUSD. |
| OpenPrice | number | Price at the start of the candle period. |
| ClosePrice | number | Price at the end of the candle period. |
| HighPrice | number | Highest traded price within the candle. |
| LowPrice | number | Lowest traded price within the candle. |
| Bid | number | Best bid price at candle close. |
| Ask | number | Best ask price at candle close. |
| Volume | number | Traded volume during the candle period. |
| OpenTime | ISO 8601 | UTC timestamp marking the candle open. |
Pagination fields
Paginated endpoints (/history, /candle) additionally return:
| Field | Type | Description |
|---|---|---|
| Data | array | Ordered list of candle objects. |
| TotalCount | integer | Total number of candles available. |
| CurrentPage | integer | Current page number (1-based). /history only. |
| TotalPages | integer | Total pages at current pageSize. /history only. |
| PageSize | integer | Number of candles on this page. /history only. |
HTTP error codes
All errors return a JSON body with a consistent
StatusCode, Message, and an Errors[] array with per-field detail.| Code | Status | When it happens |
|---|---|---|
| 400 | Bad Request | Missing or invalid query parameters. |
| 401 | Unauthorized | API key missing or malformed. |
| 403 | Forbidden | API key does not have access to this symbol or endpoint. |
| 404 | Not Found | Requested data does not exist. |
| 429 | Too Many Requests | Rate limit exceeded for your plan. |
| 500 | Internal Server Error | Unexpected server error. Please retry. |
error.json
{
"StatusCode": 400,
"Message": "Validation failed for query parameters.",
"Errors": [
{
"PropertyName": "timeFrame",
"ErrorCode": "ERR_0007_INVALID_TIME_FRAME",
"ErrorMessage": "timeFrame must be one of M1, M5, M15, H1, H4, D1"
},
{
"PropertyName": "symbolCode",
"ErrorCode": "ERR_0008_SYMBOL_NOT_SUPPORTED",
"ErrorMessage": "symbolCode BTCUSDT is not supported"
}
],
"TraceId": "00-7a8ab3af4fce34f3872a28ec7ca8f5e1-886d2e1bc76dc9a4-00"
}Recommended error handling
Check
StatusCode, then iterate Errors[] and branch on ErrorCode (a stable string identifier) rather than ErrorMessage (human text that may change). Include TraceId when reporting issues to support.Exception codes
Each entry in
Errors[] carries a structured ErrorCode. Use these for programmatic error branching.| Error code | HTTP | Description |
|---|---|---|
| ERR_0001_DATA_NOT_FOUND | 404 | No candle data found for the requested symbol and timeframe. The market may be closed or data is unavailable for the given period. |
| ERR_0005_INVALID_API_KEY | 401 | The provided API key is missing, malformed, revoked, or does not match any active key. |
| ERR_0006_INVALID_TIME_RANGE | 400 | startTime or endTime is missing, in the wrong format, out of chronological order, or exceeds the maximum range for your plan. |
| ERR_0007_INVALID_TIME_FRAME | 400 | timeFrame is not one of the supported values: M1, M5, M15, H1, H4, D1. |
| ERR_0008_SYMBOL_NOT_SUPPORTED | 403 | The symbolCode is not supported on your plan or does not exist. |
| ERR_0009_NOT_SUPPORT_WEBSOCKET | 403 | Your plan does not include WebSocket access. Upgrade to Plus or higher. |
| ERR_0010_NOT_SUPPORT_HISTORICAL | 403 | Your plan does not include historical data. Upgrade your plan to query historical candles. |
| ERR_0012_EMAIL_NOT_VERIFIED | 403 | Your email has not been verified. Verify it from the dashboard before making API requests. |
| ERR_0014_INVALID_PLAN | 403 | Your plan does not allow access to this endpoint or feature. Upgrade your plan. |