Heatmex LogoHeatmex API
Documentation
Market

Market Candle

GET /v1/public/market/candles

NOTE

  • Don't include trailing slash / at the end of the endpoint. Doing so can result in a “not found” error.
  • API requests inside/public do not require api key to be access.

INFO

The ack of market candles indicates that the request is successfully accepted.

Request Parameters

ParameterRequiredTypeComments
symboltruestringValues:
  • BTCUSDT, ETHUSDT, SOLUSDT, XRPUSDT 1000PEPEUSDT, WLDUSDT, DOGEUSDT,
  • STPTUSDT, SUIUSDT, ADAUSDT, ARBUSDT, XLMUSDT, HIVEUSDT, ONDOUSDT
intervaltruestringKline interval.1, 3, 5, 15 30, 60, 120, 240, 360, 720, D, W, M

Response Parameters

ParameterTypeComments
statusCodenumber200
resultobjectResult object
result.symbolstringValues:
  • BTCUSDT, ETHUSDT, SOLUSDT, XRPUSDT 1000PEPEUSDT, WLDUSDT, DOGEUSDT,
  • STPTUSDT, SUIUSDT, ADAUSDT, ARBUSDT, XLMUSDT, HIVEUSDT, ONDOUSDT
result.intervalstringKline interval: 1, 3, 5, 15, 30, 60, 120, 240, 360, 720, D, W, M
result.listarrayArray of kline data: [timestamp, open, high, low, close, volume, turnover]
messagestringResponse message

Request Example

GET /v1/public/market/candles HTTP/1.1
Host: api.heatmex.com
X-HEATMEX-SIGN: XXXXX
X-HEATMEX-API-KEY: XXXXX
Content-Type: application/json
const response = await fetch('https://api.heatmex.com/v1/public/market/candles')

Response Example

{
  "statusCode": 200,
  "result": {
    "symbol": "BTCUSDT",
    "interval": "1",
    "list": [
      [
        "1748849400000",
        "105225.1",
        "105394.7",
        "105128",
        "105253.9",
        "1076.945",
        "113370851.107"
      ],
      [
        "1748847600000",
        "105115.7",
        "105350",
        "105115.7",
        "105225.1",
        "887.722",
        "93440458.074"
      ]
    ]
  },
  "message": "OK"
}

Previous

Trade History

Next

Tickers

On this page