A
A
API DOC
English
Search…
⌃K

Spot

Public

Security: None

Endpoints under Public section can be accessed freely without requiring any API-key or signatures.
get
https://openapi.xxx.com
/sapi/v1/ping
Test Connectivity
get
https://openapi.xxx.com
/sapi/v1/time
Check Server Time
get
https://openapi.xxx.com
/sapi/v1/symbols
Pairs List

Response:

name
type
example
description
symbol
string
BTCUSDT
Name of the symbol
baseAsset
string
BTC
Underlying asset for the symbol
quoteAsset
string
USDT
Quote asset for the symbol
pricePrecision
integer
2
Precision of the price
quantityPrecision
integer
6
Precision of the quantity

Market

Security Type: None

Market section can be accessed freely without requiring any API-key or signatures.
get
https://openapi.xxx.com
/sapi/v1/depth
Depth

Response:

name
type
example
description
time
long
1595563624731
Current timestamp (ms)
bids
list
;
List of all bids, best bids first. See below for entry details.
asks
list
;
List of all asks, best asks first. See below for entry details.
The fields bids and asks are lists of order book price level entries, sorted from best to worst.
name
type
example
description
' '
float
131.1
price level
' '
float
2.3
The total quantity of orders for this price level
get
https://openapi.xxx.com
/sapi/v1/ticker
24hrs ticker

Response:

name
type
example
description
time
long
1595563624731
Open Time
high
float
9900
High Price
low
float
8800.34
Low Price
last
float
8900
Last Price
vol
float
4999
Trade Volume
get
https://openapi.xxx.com
/api/v1/trades
Recent Trades List

Response:

name
type
example
description
price
float
0.055
The price of the trade
time
long
1537797044116
Current timestamp (ms)
qty
float
5
The quantity traded
side
string
BUY/SELL
Taker side
get
https://openapi.xxx.com
/sapi/v1/klines
Kline/candlestick data

Response:

名称
类型
例子
描述
idx
long
1538728740000
Open time
open
float
36.00000
open price
close
float
33.00000
close price
high
float
36.00000
high price
low
float
30.00000
low price
vol
float
2456.111
volume

Trade

Security Type: TRADE

Endpoints under Trade require an API-key and a signature.
post
https://openapi.xxx.com
/sapi/v1/order
New Order

Response:

name
type
example
description
orderId
long
150695552109032492
ID of the order
clientOrderId
string
213443
A unique ID of the order.
symbol
string
BTCUSDT
Symbol Name
transactTime
integer
1273774892913
Time the order is placed
price
float
4765.29
Price of the order
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
type
string
LIMIT
Order type LIMIT,MARKET
side
string
BUY
Order side:BUY, SELL
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
post
https://openapi.xxx.com
/sapi/v1/order/test
Test New Order
post
https://openapi.xxx.com
/sapi/v1/batchOrders
Batch Orders

Resquest orders field:

name
type
example
description
price
folat
1000
Price of the order
volume
folat
20.1
Vol of the order
side
string
BUY/SELL
Side of the order
batchType
string
LIMIT/MARKET
Batch type of the order
get
https://openapi.xxx.com
/sapi/v1/order
Query Order

Response:

name
type
example
description
orderId
long
150695552109032492
ID of the order
clientOrderId
string
213443
Unique ID of the order.
symbol
string
BTCUSDT
Name of the symbol
price
float
4765.29
Price of the order
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
type
string
LIMIT
The order typeLIMIT,MARKET
side
string
BUY
The order sideBUY,SELL
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
post
https://openapi.xxx.com
/sapi/v1/cancel
Cancel Order

Response:

name
type
example
description
orderId
long
150695552109032492
ID of the order
clientOrderId
string
213443
Unique ID of the order.
symbol
string
BHTUSDT
Name of the symbol
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
post
https://openapi.xxx.com
/sapi/v1/batchCancel
Batch cancel orders
get
https://openapi.xxx.com
/sapi/v1/openOrders
Current Open Orders

Response:

name
type
example
description
orderId
long
150695552109032492
ID of the order
clientOrderId
string
213443
Unique ID of the order.
symbol
string
BTCUSDT
Name of the symbol
price
float
4765.29
Price of the order
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
type
string
LIMIT
The order typeLIMIT,MARKET
side
string
BUY
The order side BUY,SELL
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
get
https://openapi.xxx.com
/sapi/v1/myTrades
Trades

Response:

name
type
example
description
symbol
string
ETHBTC
Symbol Name
id
integer
28457
Trade ID
bidId
long
150695552109032492
Bid Order ID
askId
long
150695552109032493
Ask Order ID
price
integer
4.01
Price of the trade
qty
float
12
Quantiry of the trade
time
number
1499865549590
timestamp of the trade
isBuyer
bool
true
true= Buyer false= Seller
isMaker
bool
false
true=Maker false=Taker
feeCoin
string
ETH
Trading fee coin
fee
number
0.001
Trading fee

Account

Security Type: USER_DATA

Endpoints under Account require an API-key and a signature.
get
https://openapi.xxx.com
/sapi/v1/account
Account Information

Response:

名称
类型
描述
balances
[]
Show balance details
balances field:
name
type
example
description
asset
string
USDT
Name of the asset
free
float
1000.30
Amount available for use
locked
float
400
Amount locked (for open orders)
Last modified 8mo ago