Skip to main content

Get Index Price Kline

Query for historical index price klines. Charts are returned in groups based on the requested interval.

Covers: USDT perpetual / Inverse contract

HTTP Request

GET /cloud/trade/v3/market/index-price-kline

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct type. linear,inverse
symboltruestringSymbol name
intervaltruestringKline interval. 1,3,5,15,30,60,120,240,360,720,D,M,W
startfalseintegerThe start timestamp (ms)
endfalseintegerThe end timestamp (ms)
limitfalseintegerLimit for data size per page. [1, 1000]. Default: 200

Response Parameters

ParameterTypeComments
categorystringProduct type
symbolstringSymbol name
listarray
  • An string array of individual candle
  • Sort in reverse by startTime
> list[0]: startTimestringStart time of the candle (ms)
> list[1]: openPricestringOpen price
> list[2]: highPricestringHighest price
> list[3]: lowPricestringLowest price
> list[4]: closePricestringClose price. Is the last traded price when the candle is not closed

Request Example

GET /cloud/trade/v3/market/index-price-kline?category=inverse&symbol=BTCUSDT&interval=1&start=1670601600000&end=1670608800000&limit=2 HTTP/1.1
Host: openapi-testnet.zoomex.com

Response Example

{
"retCode": 0,
"retMsg": "OK",
"result": {
"symbol": "BTCUSDT",
"category": "linear",
"list": [
[
"1670608800000",
"17167.00",
"17167.00",
"17161.90",
"17163.07"
],
[
"1670608740000",
"17166.54",
"17167.69",
"17165.42",
"17167.00"
]
]
},
"retExtInfo": {},
"time": 1672026471128
}