Documentation Powered by ReDoc

binance-trading-api (1.0.0)

Download OpenAPI specification:Download

default

Ping

Test connectivity to the Rest API.

Responses

Time

Test connectivity to the Rest API and get the current server time.

Responses

Response samples

Content type
application/json
{
  • "serverTime": 0
}

Stream

Generate a Listen Key

Responses

Response samples

Content type
application/json
{
  • "listenKey": "string"
}

Update Stream

Ping/Keep-alive a Listen Key

path Parameters
listenKey
required
any

Responses

Update Stream

Close a ListenKey

path Parameters
listenKey
required
any

Responses

account

Account Info

Get current account information.

Responses

Account Balance

Responses

Account Transfer

Get Future Account Transaction History List.

query Parameters
startTime
required
number
asset
required
string
Example: asset=USDT

The asset being transferred

size
number [ 0 .. 100 ]
current
number >= 1

Currently querying page.

endTime
number

Responses

Account Transfer

New Future Account Transfer.

Request Body schema: application/json
amount
required
number

The amount to be transferred

asset
required
string

The asset being transferred

option
required
integer

1: transfer from spot account to USDT-Ⓜ futures account.2: transfer from USDT-Ⓜ futures account to spot account.3: transfer from spot account to COIN-Ⓜ futures account.4: transfer from COIN-Ⓜ futures account to spot account.

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "asset": "USDT",
  • "option": 0
}

Account Trade List

Get trades for a specific account and symbol.

query Parameters
symbol
required
string

Responses

Position Info

Get current position information.

query Parameters
symbol
string

Responses

Income History

query Parameters
startTime
number

Timestamp in ms to get funding from INCLUSIVE.

symbol
required
string
Example: symbol=USDT

The asset being transferred

limit
integer [ 1 .. 1000 ]
endTime
number

Timestamp in ms to get funding until INCLUSIVE.

incomeType
string
Enum: "TRANSFER" "WELCOME_BONUS" "REALIZED_PNL" "FUNDING_FEE" "COMMISSION" "INSURANCE_CLEAR"

Responses

Leverage Bracket

query Parameters
symbol
string

Responses

market

Exchange Info

Current exchange trading rules and symbol information

Responses

Order Book

query Parameters
symbol
required
string
limit
integer
Enum: 5 10 20 50 100 500 1000

Responses

Recent Trade List

Get recent trades

query Parameters
symbol
required
string
limit
integer [ 1 .. 1000 ]

Responses

Aggregate Trades List

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

query Parameters
startTime
number

Timestamp in ms to get aggregate trades from INCLUSIVE.

fromId
number

ID to get aggregate trades from INCLUSIVE.

symbol
required
string
limit
integer [ 1 .. 1000 ]
endTime
number

Timestamp in ms to get aggregate trades until INCLUSIVE.

Responses

Klines

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

query Parameters
startTime
number
symbol
required
string
limit
integer [ 1 .. 1500 ]
endTime
number
interval
required
string
Enum: "1m" "3m" "5m" "15m" "30m" "1h" "2h" "4h" "6h" "8h" "12h" "1d" "3d" "1w"

Responses

Continous Klines

Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time.

query Parameters
startTime
number
contractType
required
string
Enum: "PERPETUAL" "CURRENT_MONTH" "NEXT_MONTH" "CURRENT_QUARTER" "NEXT_QUARTER"
symbol
required
string
limit
integer [ 1 .. 1500 ]
endTime
number
interval
required
string
Enum: "1m" "3m" "5m" "15m" "30m" "1h" "2h" "4h" "6h" "8h" "12h" "1d" "3d" "1w"

Responses

Historical Klines

query Parameters
startTime
required
number
symbol
required
string
limit
integer [ 1 .. 1000 ]
endTime
number
interval
required
string
Enum: "1m" "3m" "5m" "15m" "30m" "1h" "2h" "4h" "6h" "8h" "12h" "1d" "3d" "1w"

Responses

Historical Klines

Request Body schema: application/json
endTime
number
interval
required
string
Enum: "1m" "3m" "5m" "15m" "30m" "1h" "2h" "4h" "6h" "8h" "12h" "1d" "3d" "1w"
startTime
required
number
symbol
required
string

Responses

Request samples

Content type
application/json
{
  • "endTime": 0,
  • "interval": "1m",
  • "startTime": 0,
  • "symbol": "string"
}

Mark Price

Mark Price and Funding Rate

query Parameters
symbol
string

Responses

Funding Rate History

query Parameters
symbol
string
startTime
number

Timestamp in ms to get funding rate from INCLUSIVE.

limit
integer [ 1 .. 1000 ]
endTime
number

Timestamp in ms to get funding rate until INCLUSIVE.

Responses

Ticker Daily Price Changes

24 hour rolling window price change statistics.

query Parameters
symbol
string

Responses

Symbol Price Ticker

Latest price for a symbol or symbols.

query Parameters
symbol
string

Responses

Symbol Orderbook Ticker

Best price/qty on the order book for a symbol or symbols.

query Parameters
symbol
string

Responses

Open Interest

Get present open interest of a specific symbol.

query Parameters
symbol
required
string

Responses

Open Interest Statistics

query Parameters
startTime
number
period
required
string
Enum: "5m" "15m" "30m" "1h" "2h" "4h" "6h" "12h" "1d"
symbol
required
string
limit
integer [ 1 .. 500 ]
endTime
number

Responses

trade

Order

Check an order's status.

query Parameters
symbol
required
string
origClientOrderId
string
orderId
number

Either orderId or origClientOrderId must be sent.

Responses

Order

Send in a new order.

Request Body schema: application/json
activationPrice
number

Used with TRAILING_STOP_MARKET orders, default as the latest price(supporting different workingType)

callbackRate
number [ 0.1 .. 5 ]

Used with TRAILING_STOP_MARKET orders.

closePosition
boolean

Close-All，used with STOP_MARKET or TAKE_PROFIT_MARKET.

newClientOrderId
string^[\.A-Z\:/a-z0-9_-]{1,36}$

A unique id among open orders.Automatically generated if not sent.

newOrderRespType
string
Enum: "ACK" "RESULT"
positionSide
string
Enum: "BOTH" "LONG" "SHORT"

Default for One-way Mode;LONG or SHORT must be sent in Hedge Mode.

price
number
priceProtect
boolean

Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.

quantity
number

Cannot be sent with closePosition=true(Close-All)

reduceOnly
boolean

Cannot be sent in Hedge Mode;cannot be sent with closePosition=true

side
required
string
Enum: "BUY" "SELL"
stopPrice
number

Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.

symbol
required
string
timeInForce
string
Enum: "GTC" "IOC" "FOK" "GTX"
type
required
string
Enum: "LIMIT" "MARKET" "STOP" "STOP_MARKET" "TAKE_PROFIT" "TAKE_PROFIT_MARKET" "TRAILING_STOP_MARKET"
workingType
string

stopPrice triggered by: 'ARK_PRICE' 'ONTRACT_PRICE' Default 'ONTRACT_PRICE'

Responses

Request samples

Content type
application/json
{
  • "activationPrice": 0,
  • "callbackRate": 0.1,
  • "closePosition": true,
  • "newClientOrderId": "string",
  • "newOrderRespType": "ACK",
  • "positionSide": "BOTH",
  • "price": 0,
  • "priceProtect": true,
  • "quantity": 0,
  • "reduceOnly": true,
  • "side": "BUY",
  • "stopPrice": 0,
  • "symbol": "string",
  • "timeInForce": "GTC",
  • "type": "LIMIT",
  • "workingType": "string"
}

Order

Cancel an active order.

query Parameters
symbol
required
string
origClientOrderId
string
orderId
number

Either orderId or origClientOrderId must be sent.

Responses

Mutiple Order

Request Body schema: application/json
Array of objects (BatchOrders) <= 5 items

Responses

Request samples

Content type
application/json
{
  • "batchOrders": [
    ]
}

Mutiple Order

query Parameters
symbol
required
string
orderIdList
Array of numbers

Either orderIdList or origClientOrderIdList must be sent.

origClientOrderIdList
Array of strings

Responses

Open Order

Query Current Open Order

query Parameters
symbol
required
string
origClientOrderId
string
orderId
number

Either orderId or origClientOrderId must be sent.

Responses

All Open Orders

Current All Open Orders

query Parameters
symbol
string

Responses

All Open Orders

Cancel All Open Orders

query Parameters
symbol
required
string

Responses

Change Initial Leverage

Change user's initial leverage of specific symbol market.

Request Body schema: application/json
leverage
required
integer [ 1 .. 125 ]
symbol
required
string

Responses

Request samples

Content type
application/json
{
  • "leverage": 1,
  • "symbol": "string"
}

Change Margin Type

Request Body schema: application/json
marginType
string
Enum: "ISOLATED" "CROSSED"
symbol
required
string

Responses

Request samples

Content type
application/json
{
  • "marginType": "ISOLATED",
  • "symbol": "string"
}

Position Margin

Get Position Margin Change History

query Parameters
type
integer

1: Add position margin，2: Reduce position margin

startTime
number
symbol
required
string
limit
integer
endTime
number

Responses

Position Margin

Modify Isolated Position Margin

Request Body schema: application/json
amount
required
number
positionSide
string
Enum: "BOTH" "LONG" "SHORT"

Default for One-way Mode; LONG or SHORT for Hedge Mode.It must be sent in Hedge Mode.

symbol
required
string
type
integer

1: Add position margin，2: Reduce position margin

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "positionSide": "BOTH",
  • "symbol": "string",
  • "type": 0
}

Position Mode

Get user's position mode on EVERY symbol

Responses

Position Mode

Change user's position mode on EVERY symbol

Request Body schema: application/json
dualSidePosition
required
boolean

'true': Hedge Mode; 'false': One-way Mode

Responses

Request samples

Content type
application/json
{
  • "dualSidePosition": true
}

Multi Assets Mode

Get user's Multi-Assets mode on Every symbol

Responses

Multi Assets Mode

Change user's Multi-Assets mode on Every symbol

Request Body schema: application/json
multiAssetsMargin
required
boolean

'true': Multi-Assets Mode; 'false': Single-Asset Mode

Responses

Request samples

Content type
application/json
{
  • "multiAssetsMargin": true
}