B2PRIME Docs

Get Kline (Candlestick) Data

Query for historical klines (also known as candles/candlesticks). Charts are returned in groups based on the requested interval. Used for fetching bar/candle history data with resolutions from 1 minute to daily.

GET
/marketdata/api/v4/kline

Query Parameters

symbol*string

Symbol name

interval*"1m"

Kline interval. Currently only 1m is supported. This may be expanded in the future.

Value in

  • "1m"
start?integer

Start timestamp in milliseconds

Formatint64
end?integer

End timestamp in milliseconds

Formatint64
limit?integer

Limit for data size per page. Default is 1000, maximum is 10000. If the provided limit exceeds 10000, the API returns only 10000 records.

Range1 <= value <= 10000
Default1000

Response Body

application/json

application/json

curl -X GET "https://example.com/marketdata/api/v4/kline?symbol=cfd.btc_usdt&interval=1m&start=1672502400000&end=1672588800000&limit=1000"
{  "items": [    {      "startTime": 1499040000000,      "open": "0.01634000",      "high": "0.80000000",      "low": "0.01575800",      "close": "0.01577100"    }  ]}
{  "source": "string",  "message": "string",  "stackTrace": "string"}