/binance/klines

POST /api/binance/klines

Price: 20 credits

Get historical candlestick (OHLCV) data for a trading pair

How to use it

Get native exchange candlestick (OHLCV) data for a Binance spot trading pair (e.g. 'BTCUSDT'). Each candle carries its open time, open/high/low/close prices, base-asset volume, close time, quote-asset volume, number of trades, and taker buy base/quote volumes. The interval ranges from one second to one month. By default the most recent candles are returned; pass start_time and/or end_time (unix milliseconds) to fetch a specific historical range. Candles are ordered oldest to newest.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string required — Trading pair symbol, uppercase, no separator (examples: "BTCUSDT", "ETHUSDT")
• interval string required — Candlestick interval (one of: "1s", "1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "6h", "8h", "12h", "1d", "3d", "1w", "1M")
• count integer required — Number of candles to return (min: 1)
• start_time integer nullable — Start of the range, unix milliseconds (min: 0)
• end_time integer nullable — End of the range, unix milliseconds (min: 0)
• time_zone string — Time zone offset for interpreting interval boundaries, e.g. '0', '+08:00' (default: "0")

Response

• @type string (default: "BinanceKline")
• open_at integer required
• open number required
• high number required
• low number required
• close number required
• volume number required
• close_at integer required
• quote_volume number required
• trade_count integer required
• taker_buy_base_volume number required
• taker_buy_quote_volume number required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Trading pair not found or no data in the requested range Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.