Release Time(UTC +8)	API	Initialize / Update	Description
2021.9.9	-	add	Added WebSocket market data push
2021.8.19	/v1/order/matchresults	update	add startTimestamp fields, endTimestamp fields
2018.6.10	-	Initialize	Initializes the current version of the interface

Parameter	Mandatory	Data Type	Description	Value Range
code	y	int	Status code	success：200
msg	y	string	message
time	y	long	Current millisseconds
data	y	array	symbols list

Field Type	Data Type	description
baseCurrency	string	baseCurrency code
quoteCurrency	string	quoteCurrency code
pricePrecision	integer	price precision
amountPrecision	integer	quantity precision
symbolPartition	string	symbol Partition, example:[main,innovation]
symbol	string	trade pair code
state	string	trade pair status [enable,disable]
minOrderCount	decimal	min order count
maxOrderCount	decimal	max order count
minOrderPrice	decimal	min order price
maxOrderPrice	decimal	max order price

Parameter	Mandatory	Data Type	Description	Value Range
status	y	string	Status code	success：ok，failed：error
timestamp	y	long	Current millisseconds
ticker	y	list	data

Parameter	Mandatory	Data Type	Description	Value Range
symbol	y	string	Trading pair	sellShortName_buyShortName，eg：btc_usdt
last	y	number	latest price
buy	y	number	buy
sell	y	number	sell
high	y	number	high
low	y	number	low
vol	y	number	vol
change	y	number	change

Parameter	Mandatory	Data Type	Description	Default	Value Range
step	y	int	Time：Sec		60（1min）,300（5mins）,900（15mins）,1800（30mins）,3600（1h）,86400（1d）,604800（1w）,2592000（1mon）
symbol	y	string	pairs		btc_usdt

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	return message
time	y	long	Current millisseconds
data	y	array(array(number))	Kline data

Parameter	Mandatory	Data Type	Description	Default	Value Range
symbol	y	string	Trading pair		Example：btc_usdt
step	n	int	Add the Parameter to check latest Kline data,Data Type is time,unit is sec.		60,360,560,1560,3060,6060（1h）,246060（1d）,7246060（1w）,302460*60（1mon）

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	return message
time	y	long	Current millisseconds
data	y	object	Trading deep date

Parameter	Mandatory	Data Type	Description	Default	Value Range
depth	y	object
period	n	object	Vaule only displayed when uploading step

Parameter	Mandatory	Data Type	Description
bids	y	array(array(long))	buy,[price(transaction price), amount(transaction vol)]
asks	y	array(array(long))	sell,[price(transaction price), amount(transaction vol)]
date	y	long	Timestamp
lastPrice	y	number	Latest price

Parameter	Mandatory	Data Type	Description
marketFrom	y	string	Input symbol
coinVol	y	string	Input symbol
type	y	long	Input step,time
data	y	array（array）	Last kline data,same with format above by only one

Parameter	Mandatory	Data Type	Description	Value Range
AccessKeyId	y	string	Access key
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	ApiSecret
Timestamp	y	string	Timestamp
count	y	int	Trades items	0
symbol	y	string	Trading pair	example：btc_usdt

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	return message
time	y	long	Current millisseconds
data	y	object	Real-time transactions

Parameter	Mandatory	Data Type	Description
trades	y	array(object)	trades data
sellSymbol	y	string	sellSymbol
buySymbol	y	string	buySymbol

Parameter	Mandatory	Data Type	Description	Value Range
price	y	long	transaction price
amount	y	string	transaction amount
id	y	string	transaction id
time	y	string	transaction time
en_type	y	string	direction	“bid”(buy),”ask”(sell)
type	y	string	transaction Data Type	“buy”,”sell”

Parameter	Mandatory	Data Type	Description	Default	Value Range
AccessKeyId	y	string	Access key

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	Return message
time	y	long	Current millisseconds
data	y	object	Transaction deep data

Parameter	Mandatory	Data Type	Description
netassets	y	number	net assets，unit: usdt
totalassets	y	number	total assets，unit:usdt
wallet	y	array(object)	wallet list

Parameter	Mandatory	Data Type	Description
coinName	y	long	Currency
uid	y	int	User ID
coinId	y	int	Currency ID
total	y	number	Available
frozen	y	number	On orders
symbol	y	string	Currency symbol
shortName	y	string	Abbreviation

Parameter	Mandatory	Data Type	Description	Default	Value Range
symbol	y	string	Trading pair		example：btc_usdt
type	y	string	Type		“buy” ,”sell”
tradeAmount	y	number	amount
tradePrice	y	number	price(Only for limit orders)
matchType	n	integer	Match Type	0	0-limit 1-market
marketUnit	n	string	Market Unit(Required for market orders, the amount or funds is tradeAmount)		amount-Amount funds-Funds

Parameter	Mandatory	Data Type	Description	Value Range
code	y	int	Status code	success：200，failed：300
msg	y	string	message
time	y	long	Current millisseconds
data	y	object	data

English
	Illegal request
	Illegal tradeAmount value
	Illegal tradePrice value
	Illegal symbol format

Parameter	Mandatory	Data Type	Description	Default	Value Range
ID	y	bigint	order id

Parameter	Mandatory	Data Type	Description	Default	Value Range
id	y	bigint	Order id

Parameter	Mandatory	Data Type	Description	Value Range
code	y	int	Status code	success：200，failed：300
msg	y	string	message
time	y	long	Current millisseconds

Parameter	Mandatory	Data Type	Description	Default	Value Range
id	y	bigint	order id
leverAcctid	n	string	Fields not required innon-leverorder,Sub-account id,clientId in line with API

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	message
time	y	long	Current millisseconds
data	y	object	order details

Parameter	Mandatory	Data Type	Description	Value Range
types	y	string	order type	Buy 、Sell
leftcount	y	number	Unfill
fees	y	number	Fee
last	y	number	Current order latest price
count	y	number	amount
successamount	y	number	Total transaction
source	y	string	Source	API、WEB、APP
type	y	int	Data Type code	0（Buy），1（Sell）
price	y	number	Price
buysymbol	n	string	Buy symbol
sellsymbol	n	string	Sell symbol
time	y	string	Establish time
statusCode	y	int	Status code	1 Unfilled 2 Partial filled 3 Filled 4 Revoking 5 Cancelled
status	y	int	Status	Unfill,Partial filled,Filled,Revoking,Cancelled

Parameter	Mandatory	Data Type	Description	Default	Value Range
id	y	bigint	order id

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	message
time	y	long	Current millisseconds
data	y	object	Order detail

Parameter	Mandatory	Data Type	Description	Default	Value Range
entrusts	y	array(object)	BBO list

Parameter	Mandatory	Data Type	Description
id	y	bigint	Primary key ID
isSelfTrade	y	int	Self-trade Option 0 n 1 y
sysmbol	y	string	Trading pairs
entrustType	y	int	orderData Type 0 Buy 1 Sell
entrustId	y	bigint	order id
matchId	y	bigint	Transaction ID
amount	y	number	Total Transaction
prize	y	number	Price
count	y	number	Amount
createTime	y	string	Create time

Parameter	Mandatory	Data Type	Description	Default	Value Range
symbol	y	string	Trading pairs		example：btc_usdt
type	n	int	Data Type	0	0 is all 1 iscurrent 2 is history
page	n	int	page	1
count	y	int	items	7	[1-100] max 100 items

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	Return message
time	y	long	Current millisseconds
data	y	object	Order details

Parameter	Mandatory	Data Type	Description	Default	Value Range
entrutsCur	n	array(object)	Current order
entrutsHis	n	array(object)	History order

Parameter	Mandatory	Data Type	Description	Value Range
id	y	bigint	Order id
time	y	string	Order time
types	y	string	Order Type	Buy、Sell
source	y	string	Order source	“WEB”，”APP”，”API”
price	y	number	Order price
count	y	number	Order amount
leftcount	y	number	Unfill amount
last	y	number	Transaction price
successamount	y	number	Total Transaction
fees	y	number	fee
status	y	string	Order Status	Unfill,Partial filled,Filled,Revoking,Cancelled
type	y	int	Order Data Type	0( “Buy”),1( “Sell”)
buysymbol	y	string	Currency Data Type symbol
sellsymbol	y	string	Currency Data Type symbol

Parameter	Mandatory	Data Type	Description	Default	Value Range
symbol	y	string	Trading pairs		example：btc_usdt
types	n	string	query order Data Type compositio，separate by’,’		0：buy, 1：sell
startDate	n	string	Inquire start date, date form yyyy-mm-dd	-1d Inquire the day before end data	Value Range [((endDate) – 1), (endDate)] ，Max inquery date is 2 days in query window, inquery ranges of nearly 61 days
endDate	n	string	Inqery end date, date form yyyy-mm-dd	today	Value Range [(today-60), today] ，Max inquery date is 2 days in query window, inquery ranges of nearly 61 days
startTimestamp	n	Long	Inquire start time, Unix timestamp, in milliseconds. You are advised to use startDate, which can be queried in milliseconds	required when querying by timestamp	Value Range [((endTimestamp) – 1), (endTimestamp)] ，Max inquery date is 2 days in query window, inquery ranges of nearly 61 days
endTimestamp	n	Long	Inquire end time, Unix timestamp, in milliseconds. You are advised to use endDate, which can be queried in milliseconds	required when querying by timestamp	Value Range [(today-60), today] ，Max inquery date is 2 days in query window, inquery ranges of nearly 61 days
from	n	string	Inquire start&end ID	order history record ID（max）
direct	n	string	Direction	default next， transaction record ID orders from big to small	prev forward，time（or ID）positive sequence；next backward，time（or ID）reverse）
size	n	string	query record scope	100	[1，100]

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	return message
time	y	long	Current millisseconds
data	y	object	Real-time transactions

Parameter	Mandatory	Data Type	Description	Default	Value Range
entrustdetail	n	array(object)	Transaction Record

Parameter	Mandatory	Data Type	Description	Value Range
createdAt	y	long	Transaction time
filledAmount	y	string	Transaction amount
filledFees	y	string	Transaction fee
id	y	long	Transaction record id
matchId	y	long	Matchmaking id
orderId	y	long	Order id
price	y	string	Transaction price
type	y	string	Order Data Type	0：buy, 1：sell
role	y	string	Transaction role	taker,maker

Parameter	Mandatory	Data Type	Description	Default	Value Range
orderIds	y	String	Revoke order ID list		Shall not exceeds 100 order ID each time Example”2232,1232,2321”

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	Return message
data	y	object

Parameter	Mandatory	Data Type	Description	Default	Value Range
symbol	y	String	Transaction code list( Max 10 symbols,separate by commas between various trade codes)，btc_usdt, eth_btc…
side	n	String	Direction		when buy -buy direction sell -sell direction is empty，obtain orders of all directions to revoke.

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	Return message
data	y	object

Parameter	Mandatory	Data Type	Description	Default	Value Range
{successCount	y	int	Success cancel amount
failCount}	y	int	Cancelled failed amount

Parameter	Mandatory	Data Type	Description	Default	Value Range
orders	y	object	Order list

Parameter	Mandatory	Data Type	Description	Default	Value Range
[{symbol	y	string	Trading pairs		example：btc_usdt
type	y	string	Data Type		“buy” ,”sell”
tradeAmount	y	number	Amount
tradePrice	y	number	Price(Only for limit orders)
matchType	n	integer	Match Type	0	0-limit 1-market
marketUnit}]	n	string	Market Unit(Required for market orders, the amount or funds is tradeAmount)		amount-Amount funds-Funds

Parameter	Mandatory	Data Type	Description
code	y	int	Status code
msg	n	string	Return message
data	y	object

sort: 3 # follow a certain sequence of letters or numbers

Market API

Available Futures List

GET /api/v1/perpetual/public

Return：

Parameter	Mandatory	Type	Description
code	y	int	status，200：success
msg	y	string	Tips
data	y	object	Derivatives Info

Response

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "amount24": "3848",
            "base": "btc",
            "code": "btcusd",
            "direction": 1,
            "env": 1,
            "fluctuation": "-10.04",
            "fund": "0.00375",
            "high": "9100",
            "indexPrice": "7913.84",
            "low": "8100",
            "markPrice": "7918.29",
            "maxLever": 100,
            "minQuoteDigit": 2,
            "minTradeDigit": 8,
            "price": "8100",
            "quote": "usd",
            "size24": "4.39717319",
            "totalPosition": "1830",
            "unitAmount": 10
        }
    ],
}
  

Derivatives InfoReturn：

Parameter	Mandatory	Type	Description
code	y	string	Contractcode
base	y	string	base currency name,如btc、usdt
quote	y	string	quote currency name，usd,usdt
direction	y	string	Side 0:Linear Contract,1:Inverse Contract
minTradeDigit	y	string	Min. transaction decimal places of base currency
minQuoteDigit	y	string	Min. transaction decimal places of quote currency
price	y	string	Latest Price
quote	y	string	quote change
fluctuation	y	string	quote change
high	y	string	Highest price
low	y	string	Lowest price
amount24	y	string	24H Vol.(Cont)
size24	y	string	24H Vol.(Cont)
totalPosition	y	string	Holdings of lowest price
fund	y	string	Fee rate
markPrice	y	string	Mark price
indexPrice	y	string	Index price
unitAmount	y	string	quoteFace value of a contract, Default1
env	y	string	Test or not 0:listing,1:testing
maxLever	y	string	Max.Leverage

Kline

GET /api/v1/perpetual/public/{contractCode}/candles

Request Parameter:

Path Parameter

Parameter	Mandatory	Type	Description	Default Value	Value Range
contractCode	y	string	Futurescode

Query

Parameter	Mandatory	Type	Description	Default Value	Value Range
kline	y	string	klineType		1min,3min,5min,15min,30min,1hour,2hour,4hour,6hour,12hour,day,week
since	n	int	Timestamp,Default Value0
size	n	int	Klineamount
klineType	n	int	KlineType	1	1-Latest Price 2-Mark Price 3-Index Price

Return：

Response

{
    "code":0,
    "data":[
        [
            1543405500000,//time
            "100",//Lowest
            "100",//Highest
            "100",//Open price
            "100",//Close price
            "0",//Transaction Vol.
            "0"//Transaction value
        ]
    ],
    "msg":"success"
}
  

Parameter	Mandatory	Type	Description
code	y	int	status，200：success
msg	y	string	Tips
data	y	object

Depth Info

GET /api/v1/perpetual/public/products/{contractCode}/orderbook

Path Parameter

Parameter	Mandatory	Type	Description	Default Value	Value Range
contractCode	y	string	Futurescode

Response

{
    "asks": [
      //asks
        [
            "9721.47",  //price
            "225",      //(Cont)
            "225"       //Total(Cont)
        ]
    ],
    "bids": [
      //bids
        [
            "9720", 
            "480",
            "480"
        ]
    ]
}
  

Return：

Parameter	Mandatory	Type	Description	Default Value	Value Range
asks	y	object	ask
bids	y	object	bid

Latest transaction data

GET /api/v1/perpetual/public/{contractCode}/fills

Request Parameter：

Path Parameter

Parameter|Mandatory|Type|Description|Default Value|Value Range ————- | ————- | ————- | ————- | ————- | ————- contractCode|y|string|Futurescode||

Response

{
    "code": 200,
    "data": [
        [
            "9695.28",  //Deal price
            "496",      //(Cont)
            "long",     //Side
            1582269058972, //time
            9916897     //transactionid
        ]
    ],
    "msg": "success"
}
  

Return：

Parameter	Mandatory	Type	Description
code	y	string	statuscode
data	y	object	Returnresult
msg	y	string	Info

Index Price Info

GET /api/v1/perpetual/public/{contractCode}/indexInfo

Request Parameter：

Path Parameter

| Parameter | Mandatory | Type | Description | Default Value | Value Range | | ———— | ——— | —— | ———– | ————- | ———– | | contractCode | y | string | Futurescode | | |

Response

{
    "code": 200,
    "data": {
        "components": [
            {
                "name": "binance_contract",
                "price": "38983.69999999",
                "symbol": "BTC/USDT",
                "wgt": "1"
            }
        ],
        "index": "btc",
        "indexPrice": "38983.69999999",
        "time": 1650269513885
    },
    "msg": "success"
}
  

Return：

Parameter	Type	Description	Default Value
components	obejct	Individual Exchange Index Info
>name	string	Exchange Name	binance_contract-Binance Futures，binance-Binance，huobi-Huobi，okex-OK
>price	string	Price
>symbol	string	Trade Pairs
>wgt	number	Weight
index	object	Index currency
indexPrice	string	Index price
time	number	Time

资金费用历史

GET /api/v1/perpetual/public/{contractCode}/fee-rate

Path Parameter

Parameter	Mandatory	Type	Description
contractCode	y	string	Futurescode
page	n	int	Page
pageSize	n	int	Size

Return：

Response

{
    "code":200,
    "data":
    {
            "amount24":830768400,
            "contractCode":"etcusd",
            "createdDate":1546603201000,
            "feeRate":-0.00375,
            "id":5,
            "insuranceSize":0,
            "modifyDate":1546603201000,
            "size24":8307684,
            "timeIndex":1546603201000,
            "userPositionAmount":198000000
    },
    "msg":"success"
}
  

Parameter	Mandatory	Type	Description
amount24	y	string	24H Vol.
contractCode	y	string	Futurescode
createdDate	y	string	Creation Time
feeRate	y	string	Fee rate
id	y	string	PRIMARY KEYid
insuranceSize	y	string	Risk Reserves
modifyDate	y	string	Modify time
size24	y	string	24H Vol.(Cont)
timeIndex	y	string	Time to generate current data
userPositionAmount	y	string	Total Holdings

Latest Mark price and Fee rate

GET /api/v1/perpetual/public/{contractode}/premiumIndex

Path Parameter

Parameter	Mandatory	Type	Description	Default Value	Value Range
contractCode	y	string	Futurescode

Return：

Response

{
    "code": 200,
    "data": {
        "baseCurrency": "usdt",
        "contractCode": "btcusdt",
        "estimateFeeRate": "0.00375",
        "indexPrice": "39008.4",
        "lastFeeRate": "0.00375",
        "lastPrice": "41500",
        "markPrice": "39008.4",
        "quoteCurrency": "usdt",
        "time": 1650270347001,
        "totalPosition": "19193"
    },
    "msg": "success"
}

  

Parameter	Type	Description
baseCurrency	string	Base currency
contractCode	string	Contractcode
estimateFeeRate	string	EstimateFee rate
indexPrice	string	Index price
lastFeeRate	string	Last updatedFee rate
lastPrice	string	Latest transaction price
markPrice	string	Mark price
quoteCurrency	string	Quote currency
time	string	Update time
totalPosition	string	Total Positions