Docs
View as Markdown

binance.klines

stable Advanced

Candlesticks (OHLCV) for a spot symbol.

GET /v1/binance/klines

What you get#

A list of Binance results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
symbolstringyes(required)Spot symbol, UPPERCASE, e.g. BTCUSDTmax 20 chars; must match [A-Z0-9]{2,20}; trimmed
intervalstringno1hCandle intervalmax 3 chars; must match 1s|1m|3m|5m|15m|30m|1h|2h|4h|6h|8h|12h|1d|3d|1w|1M; trimmed
limitstringno100Number of candles (1-500)max 3 chars; must match [1-9]\d{0,2}; trimmed

Request#

curl "https://api.onekey.dev/v1/binance/klines?symbol=BTCUSDT&limit=10" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Binance response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "date": "2026-09-28T11:00:00Z"
      },
      "market": {
        "open": 82960.01,
        "high": 83111,
        "low": 82960,
        "close": 83082.54,
        "volume": 835.88182
      },
      "ext": {
        "quoteVolume": 69399669.7551971,
        "trades": 110650
      }
    },
    {
      "entity": {
        "date": "2026-09-28T12:00:00Z"
      },
      "market": {
        "open": 83082.53,
        "high": 83631.43,
        "low": 83011.48,
        "close": 83579.75,
        "volume": 1210.60365
      },
      "ext": {
        "quoteVolume": 100953437.1295968,
        "trades": 159385
      }
    }
  ],
  "metadata": {
    "platform": "binance",
    "endpoint": "klines",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
0entity.datetoIsoDate
1market.opentoNumber
2market.hightoNumber
3market.lowtoNumber
4market.closetoNumber
5market.volumetoNumber
7ext.quoteVolumetoNumber
8ext.tradestoNumber

Caching and freshness#

  • Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
  • Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).