# Spot

# Public

# Security: None

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

# Test Connectivity

This endpoint checks connectivity to the host

sdk: TestConnectivity.java

Parameters

Responses

🟢 200 Connection normal

# Check Server Time

This endpoint checks connectivity to the server and retrieves server timestamp

sdk: CheckServerTime.java

Parameters

Responses

🟢 200 Successfully retrieved server time

# Pairs List

This endpoint retrieves coin pairs list

sdk: PairsList.java

Parameters

Responses

🟢 200 Successfully retrieved 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.

# Depth

This endpoint retrieves market depth data

sdk: Depth.java

Parameters

Query

name	type	description
`symbol`	string	Symbol name E.g. `BTCUSDT`
`limit`	integer	Default 100; Max 100

Responses

🟢 200 Successfully retrieved market depth data

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

24 hour price change statistics

sdk: Ticker.java

Parameters

Query

name	type	description
`symbol`	string	Symbol name E.g. `BTCUSDT`

Responses

🟢 200 Successfully retrieved ticker data

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

sdk: RecentTradesList.java

Parameters

Query

name	type	description
`symbol`	string	Symbol name E.g. `BTCUSDT`
`limit`	string	Default 100; Max 1000

Responses

🟢 200

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

sdk: KlineCandlestickData.java

Parameters

Query

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

Responses

🟢 200

Response

name	type	example	description
`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

Rate Limit: 100times/2s

sdk: NewOrder.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

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
newClientOrder	string	Unique order ID generated by users to mark their orders
recvWindow	integer	Time window

Responses

🟢 200 Successfully post 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`.

# Test New Order

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: TestNewOrder.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

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
newClientOrder	string	Unique order ID generated by users to mark their orders

Responses

🟢 200 Successfully test new order

# Batch Orders

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

sdk: BatchOrders.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Body

name	type	description
orders	array	Batch order param
symbol	string	Symbol Name. E.g. `BTCUSDT`

Responses

🟢 200

Request orders field:

name	type	example	description
`price`	float	`1000`	Price of the order
`volume`	float	`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

Rate Limit: 20times/2s

sdk: QueryOrder.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Body

name	type	description
orderId	array	Order ID
newClientOrderId	string	Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444
symbol	string	Symbol Name. E.g. `BTCUSDT`

Responses

🟢 200

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
`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`	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`.

# Cancel Order

Rate Limit: 100time/2s

sdk: CancelOrder.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Body

name	type	description
orderId	array	Order ID
newClientOrderId	string	Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444
symbol	string	Symbol Name. E.g. `BTCUSDT`

Responses

🟢 200 Order cancellation successful

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
`status`	string	`NEW`	The state of the order. Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED` and `REJECTED`.

# Batch cancel orders

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

sdk: BatchCancelOrders.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Body

name	type	description
orderId	array	Order ID collection `[123,456]`
symbol	string	Symbol Name. E.g. `BTCUSDT`

Responses

🟢 200 Batch order cancellation successful

# Current open Orders

Rate Limit: 20times/2s

sdk: CurrentOpenOrders.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Body

name	type	description
symbol	string	Symbol Name. E.g. `BTCUSDT`
limit	integer	Default 100; Max 1000

Responses

🟢 200

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
`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`	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`.

# Trades

Rate Limit: 20times/2s

sdk: Trades.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Body

name	type	description
symbol	string	Symbol Name. E.g. `BTCUSDT`
limit	integer	Default 100; Max 1000
fromId	integer	Trade Id to fetch from

Responses

🟢 200

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`	Quantity 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

Rate Limit: 20times/2s

sdk: AccountInformation.java

Parameters

Query
Header

name	type	description
X-CH-SIGN	string	Sign
X-CH-APIKEY	string	Your API-Key
X-CH-TS	integer	Timestamp

Responses

🟢 200 Successfully retrieved account information

Response

name	type	description
`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)