Get Crypto Candlesticks

Query public OHLCV candlesticks by currency code, including request parameters, time units, and response fields.

GET /api/v4/event_contracts/crypto/candlesticks

Get Crypto Candlesticks

cURL

curl --request GET \
  --url https://api.dexbuilder.com/api/v4/event_contracts/crypto/candlesticks

200

{
  "symbol": "<string>",
  "interval": "<string>",
  "history": [
    {
      "t": 123,
      "o": "<string>",
      "h": "<string>",
      "l": "<string>",
      "c": "<string>",
      "v": "<string>"
    }
  ],
  "source": "<string>"
}

Use a currency code to query public OHLCV candlesticks. Authentication is not required.

Base URL: https://api.dexbuilder.com

​

Request parameters

Parameter	Required	Description
symbol	One of two	Case-insensitive currency code. Currently supported: BTC, ETH, HYPE, XRP, SOL, DOGE, and BNB. Use this parameter for new integrations.
tag_id	One of two	Compatibility parameter: positive cryptocurrency tag ID; for example, BTC is 235. Do not add the ge_ prefix.
interval	Yes	Display interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w, 1mon, 1y, or all.
start_ts	No	Start time in Unix seconds; omit or pass 0 to use the server’s default boundary rule.
end_ts	No	End time in Unix seconds; omit or pass 0 to use the server’s default boundary rule.

Provide exactly one of symbol or tag_id. The tag_id parameter remains temporarily supported; existing integrations should migrate to symbol. When both boundaries are nonzero, end_ts must be greater than start_ts.

interval selects a display interval and does not guarantee the width of each returned candlestick. Use history[].t to read sample times. interval=all does not guarantee the full price history; specify start_ts and end_ts to query a particular range.

curl "https://api.dexbuilder.com/api/v4/event_contracts/crypto/candlesticks?symbol=BTC&interval=1h"

​

Response

A successful response contains the currency pair, display interval, and candlestick history:

{
  "symbol": "BTCUSD",
  "interval": "1h",
  "source": "binance",
  "history": [
    { "t": 1700000000, "o": "30000", "h": "30100", "l": "29900", "c": "30050", "v": "12.5" }
  ]
}

history[].t is a Unix timestamp in seconds. Open, high, low, close, and volume are decimal strings. source is a data source name and is omitted when unavailable. Sources without volume may return "0"; no data returns an empty history array.

Invalid parameters return HTTP 400 with label set to INVALID_PARAM_VALUE. An unavailable quote source returns HTTP 503 with label set to QUOTE_UNAVAILABLE.

Query Parameters

symbol · string

Case-insensitive currency code. Currently supported: BTC, ETH, HYPE, XRP, SOL, DOGE, and BNB. Provide either symbol or tag_id.

Example:

"BTC"

tag_id · integer

Compatibility parameter: positive cryptocurrency tag ID. Provide either symbol or tag_id. Use symbol for new integrations.

Required range: x >= 1

Example:

235

interval · enum<string> · required

Display interval.

Available options: 1m, 5m, 15m, 1h, 4h, 1d, 1w, 1mon, 1y, all

start_ts · integer

Start time in Unix seconds; omitted or 0 follows the server's default rule.

Required range: x >= 0

end_ts · integer

End time in Unix seconds; omitted or 0 follows the server's default rule.

Required range: x >= 0

Response

200

application/json

Request succeeded

Crypto candlestick response.

symbol · string · required

Currency pair identifier.

interval · string · required

history · object[] · required

OHLCV candlesticks in time order.

Show child attributes

source · string

Data source name; omitted when unavailable.