Spot

Public

Security: None

Endpoints under Public section can be accessed freely without requiring any API-key or signatures.

Test Connectivity

GET https://openapi.xxx.com/sapi/v1/ping

This endpoint checks connectivity to the host

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/TestConnectivity.java

200 Connection normal

{}

Check Server Time

GET https://openapi.xxx.com/sapi/v1/time

This endpoint checks connectivity to the server and retrieves server timestamp

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/CheckServerTime.java

200 Successfully retrieved server time

{
    "timezone": "GMT+08:00",
    "serverTime": 1595563624731
}

Pairs List

GET https://openapi.xxx.com/sapi/v1/symbols

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/PairsList.java

200 Successfully retrieved pairs list

{
    "symbols": [
        {
            "quantityPrecision": 3,
            "symbol": "sccadai",
            "pricePrecision": 6,
            "baseAsset": "SCCA",
            "quoteAsset": "DAI"
        },
        {
            "quantityPrecision": 8,
            "symbol": "btcusdt",
            "pricePrecision": 2,
            "baseAsset": "BTC",
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 3,
            "symbol": "bchusdt",
            "pricePrecision": 2,
            "baseAsset": "BCH",
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "symbol": "etcusdt",
            "pricePrecision": 2,
            "baseAsset": "ETC",
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "symbol": "ltcbtc",
            "pricePrecision": 6,
            "baseAsset": "LTC",
            "quoteAsset": "BTC"
        }
    ]
}

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.

Depth

GET https://openapi.xxx.com/sapi/v1/depth

market detpth data

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/Depth.java

Query Parameters

Name	Type	Description
limit*	integer	Default 100; Max 100
symbol*	string	Symbol Name E.g. BTCUSDT

200 Successfully retrieved market depth data

{
  "bids": [
    [
      "3.90000000",   // price
      "431.00000000"  // vol
    ],
    [
      "4.00000000",
      "431.00000000"
    ]
  ],
  "asks": [
    [
      "4.00000200",  // price
      "12.00000000"  // vol
    ],
    [
      "5.10000000",
      "28.00000000"
    ]
  ]
}

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

24hrs ticker

GET https://openapi.xxx.com/sapi/v1/ticker

24 hour price change statistics.

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/Ticker.java

Query Parameters

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT

200 Successfully retrieved ticker data

{
    "high": "9279.0301",
    "vol": "1302",
    "last": "9200",
    "low": "9279.0301",
    "rose": "0",
    "time": 1595563624731
}

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

Recent Trades List

GET https://openapi.xxx.com/api/v1/trades

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/RecentTradesList.java

Query Parameters

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT
limit*	string	Default 100; Max 1000

200

[
  {
    "price": "3.00000100",
    "qty": "11.00000000",
    "time": 1499865549590,
    "side": "BUY"
  },...
]

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

Kline/candlestick data

GET https://openapi.xxx.com/sapi/v1/klines

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/KlineCandlestickData.java

Query Parameters

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT
interval*	string	Interval of the Kline. Possible values include: 1min,5min,15min,30min,60min,1day,1week,1month
limit*	integer	Default 100; Max 300

200

[
    {
        "high": "6228.77",
        "vol": "111",
        "low": "6228.77",
        "idx": 1594640340,
        "close": "6228.77",
        "open": "6228.77"
    },
    {
        "high": "6228.77",
        "vol": "222",
        "low": "6228.77",
        "idx": 1587632160,
        "close": "6228.77",
        "open": "6228.77"
    },
    {
        "high": "6228.77",
        "vol": "333",
        "low": "6228.77",
        "idx": 1587632100,
        "close": "6228.77",
        "open": "6228.77"
    }
]

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.

New Order

POST https://openapi.xxx.com/sapi/v1/order

Rate Limit: 100times/2s

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/NewOrder.java

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

Request Body

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT
volume*	number	Order vol. For MARKET BUY orders, vol=amount.
side*	string	Side of the order,BUY/SELL
type*	string	Type of the order, LIMIT/MARKET
price	number	Order price, REQUIRED for LIMIT orders
newClientOrderId	string	Unique order ID generated by users to mark their orders
recvWindow	integer	Time window

200 Successfully post new order

{
    'symbol': 'LXTUSDT', 
    'orderId': '150695552109032492', 
    'clientOrderId': '157371322565051',
    'transactTime': '1573713225668', 
    'price': '0.005452', 
    'origQty': '110', 
    'executedQty': '0', 
    'status': 'NEW',
    'type': 'LIMIT', 
    'side': 'SELL'
}

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.

Test New Order

POST https://openapi.xxx.com/sapi/v1/order/test

Test new order creation and signature/recvWindow length. Creates and validates a new order but does not send the order into the matching engine.

sdk：https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/TestNewOrder.java

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

Request Body

Name	Type	Description
recvWindow	integer	Time window
symbol*	string	Symbol Name. E.g. BTCUSDT
volume*	number	Order vol. For MARKET BUY orders, vol=amount.
side*	string	Side of the order, BUY/SELL
type*	string	Type of the order, LIMIT/MARKET
price	number	Order price, REQUIRED for LIMIT orders
newClientOrderId	string	Unique order ID generated by users to mark their orders

200 Successfully test new order

{}

Batch Orders

POST https://openapi.xxx.com/sapi/v1/batchOrders

Rate Limit: 50times/2s A batch contains at most 10 orders

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/BatchOrders.java

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

Request Body

Name	Type	Description
orders*	array	Batch order param
symbol*	string	Symbol Name. E.g. BTCUSDT

200

{
    "ids": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ]
}

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

Query Order

GET https://openapi.xxx.com/sapi/v1/order

Rate Limit: 20times/2s

sdk：https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/QueryOrder.java

Query Parameters

Name	Type	Description
orderId*	string	Order ID
newClientOrderId	string	Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444heihieddada
symbol*	string	Symbol Name. E.g. BTCUSDT

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

200

{
    'orderId': '499890200602846976', 
    'clientOrderId': '157432755564968', 
    'symbol': 'BHTUSDT', 
    'price': '0.01', 
    'origQty': '50', 
    'executedQty': '0', 
    'avgPrice': '0', 
    'status': 'NEW', 
    'type': 'LIMIT', 
    'side': 'BUY', 
    'transactTime': '1574327555669'
}

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.

Cancel Order

POST https://openapi.xxx.com/sapi/v1/cancel

Rate Limit: 100time/2s

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/CancelOrder.java

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

Request Body

Name	Type	Description
orderId*	string	Order ID
newClientOrderId	string	Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444heihieddada
symbol*	string	Symbol Name. E.g. BTCUSDT

200 撤销订单成功

{
    'symbol': 'BHTUSDT', 
    'clientOrderId': '0', 
    'orderId': '499890200602846976', 
    'status': 'CANCELED'
}

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.

Batch cancel orders

POST https://openapi.xxx.com/sapi/v1/batchCancel

Rate Limit: 50times/2s A batch contains at most 10 orders

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/BatchCancelOrders.java

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

Request Body

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT
orderIds*	array	Order ID collection [123,456]

200

{
    "success": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ],
    "failed": [ //cancel fails because the order does not exist or the order state has expired
        165964665990709250  
    ]
}

Current Open Orders

GET https://openapi.xxx.com/sapi/v1/openOrders

Rate Limit: 20times/2s

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/CurrentOpenOrders.java

Query Parameters

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT
limit*	integer	Default 100; Max 1000

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

200

[
    {
        'orderId': '499902955766523648', 
        'symbol': 'BHTUSDT', 
        'price': '0.01', 
        'origQty': '50', 
        'executedQty': '0', 
        'avgPrice': '0', 
        'status': 'NEW', 
        'type': 'LIMIT', 
        'side': 'BUY', 
        'time': '1574329076202'
        },...
]

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.

Trades

GET https://openapi.xxx.com/sapi/v1/myTrades

Rate Limt: 20times/2s

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/Trades.java

Query Parameters

Name	Type	Description
symbol*	string	Symbol Name. E.g. BTCUSDT
limit*	string	Default 100; Max1000
fromId*	integer	Trade Id to fetch from

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

200

[
  {
    "symbol": "ETHBTC",
    "id": 100211,
    "bidId": 150695552109032492,
    "askId": 150695552109032493,
    "price": "4.00000100",
    "qty": "12.00000000",
    "time": 1499865549590,
    "isBuyer": true,
    "isMaker": false,
    "feeCoin": "ETH",
    "fee":"0.001"
  },...
]

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.

Account Information

GET https://openapi.xxx.com/sapi/v1/account

Rate Limit: 20times/2s

sdk:https://github.com/exchange2021/openapidemo/blob/master/src/main/java/com/spot/AccountInformation.java

Headers

Name	Type	Description
X-CH-SIGN*	string	Sign
X-CH-APIKEY*	string	Your API-key
X-CH-TS*	integer	timestamp

200 Successfully retrieved account information.

{
    'balances': 
        [
            {
                'asset': 'BTC', 
                'free': '0', 
                'locked': '0'
                }, 
            {
                'asset': 'ETH', 
                'free': '0', 
                'locked': '0'
                },...
        ]
}

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)