REST reference / Market data

Candlesticks

GET/fapi/v1/klines
PublicWeight 5

Overview

Local trade candles, higher intervals rolled up on read

Parameters

symbolstringrequired

Listed symbol, for example BTCUSDT. Unlisted symbols return -1121.

Constraints
type
"string"
startTimeintegeroptional

Inclusive epoch milliseconds; absent means unbounded.

Constraints
type
"integer"
format
"int64"
endTimeintegeroptional

Inclusive epoch milliseconds; absent means unbounded.

Constraints
type
"integer"
format
"int64"
limitintegeroptional

Values above 1500 are clamped to 1500.

Constraints
type
"integer"
minimum
1
default
500
intervalstringoptional

Candles come from local trades, not upstream exchange candles.

Constraints
type
"string"
enum
["1m","3m","5m","15m","30m","1h","2h","4h","6h","12h","1d"]
default
"1m"

Responses

Success

Array items Kline

Ordered tuple: openTime, open, high, low, close, volume, closeTime, quoteVolume, tradeCount, takerBuyVolume, takerBuyQuote, ignore.

Ordered tuple · 12 items

[0]integer
type
"integer"
format
"int64"
[1]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[2]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[3]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[4]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[5]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[6]integer
type
"integer"
format
"int64"
[7]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[8]integer
type
"integer"
format
"int64"
[9]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[10]string

Decimal encoded as a string. Precision follows the symbol or the field's documented scale. Never convert to a binary floating-point number for signing or accounting.

type
"string"
pattern
"^-?[0-9]+(\\.[0-9]+)?$"
[11]string
type
"string"
enum
["0"]
type
"array"
minItems
12
maxItems
12
type
"array"
Response headers
X-MBX-USED-WEIGHT-1M

Per-IP admitted request weight in the current minute. Requests admitted by the limiter count even if authentication or validation later fails.

Raw response schema
Response schema
{
  "$ref": "#/components/schemas/Klines"
}
Errors, limits and retry behavior