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

Release Time (UTC +8)	API	New/Update	Description
2022.02.21	-	Add	Add perpetual api doc.
2024.04.16	-	Add	Add Subscribe to contract push api doc.

Parameter	Mandatory	Type	Description	Default	Value Range
contractCode	y	string	Contractcode

Parameter	Mandatory	Type	Description
currencyCode	y	string	Currency
env	y	int	testing coin or not 0:listing coin,1:testing coin
availableMargin	y	string	Avail.margin
realizedSurplus	y	string	Realized P/L
orderMargin	y	string	Order margin
positionMargin	y	string	Position margin
unRealizedSurplus	y	string	Unrealized P/L
accountRights	y	string	Equity

Parameter	Mandatory	Type	Description
availableBalance	y	string	Available balance
currencyCode	y	string	Currency
env	y	int	testing coin or not 0:listing coin,1:testing coin
frozenBalance	y	string	frozen balance（in transfer audit）
orderMargin	y	string	Order margin
positionMargin	y	string	Position margin
positionAccountRights	y	string	Equity
realizedSurplus	y	string	Realized P/L
unRealizedSurplus	y	string	Unrealized P/L

Parameter	Mandatory	Type	Description
amount	y	string	Transaction amount
contractCode	y	string	Contractcode
createDate	y	string	Creation time
currencyCode	y	string	Currency
dealType	y	string	TransactionType，1：Self-match，2：Deal with other users
detailSide	y	string	Side
fee	y	string	Fee
id	y	long	TransactionHistoryid
makerTaker	y	string	maker or taker
orderId	y	long	Orderid
price	y	string	Transaction price
profit	y	string	Profit
refOrderId	y	long	ReferOrderid
size	y	string	Transaction Value
userId	y	long	uid

Parameter	Mandatory	Type	Description	Default Value	Value Range
type	y	string	Type		10 Limit or Conditional 11 Market price
triggerBy	n	string	triggerType		Conditional option, if not conditional order this field must be NULL，IndexPrice：index，MarkPrice：mark，LastPrice：last
triggerPrice	n	string	Conditional option trigger price
side	y	string	Side		open_long Open Long open_short Open Short close_long Close Long close_short Close Short
price	y	string	Price
ioc	n	int	if orders cannot be immediately traded , the untranslated part will be cancelled immediately	0	0: Disable，1: Enable
amount	y	int	Amount
beMaker	n	int	Timestamp	0	Post-only：0:Not Post-only 1:Post-only

Parameter	Mandatory	Type	Description	Default Value	Value Range
id	y	long	Orderid

Parameter	Mandatory	Type	Description	Value Range
positionId	n	long	Position ID	Mandatory when closing a position in partition mode, can also be passed when adding to a position
type	y	string	Type	12 :conditional order
triggerBy	n	string	triggerType	default “mark”，MarkPrice：mark，LastPrice：last
triggerPrice	n	string	Conditional option trigger price	Conditional option trigger price
side	y	string	Side	open_long Open Long, open_short Open Short ,close_long Close Long, close_short Close Short
price	y	string	Price	Price
amount	y	int	Amount	Amount
algoType	y	int	Order type	10 Limit price , 11 Market price
currentPrice	y	string	Current contract price	The current contract price, to determine the direction of profit and loss

Parameter	Mandatory	Type	Description	Default Value	Value Range
id	y	long	Orderid

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

Parameter	Mandatory	Type	Description	Default Value	Value Range
positionId	n	long	Position ID		Mandatory when closing a position in partition mode, can also be passed when adding to a position
type	y	string	Type		10 Limit or Conditional 11 Market price
side	y	string	Side		open_long Open Long open_short Open Short close_long Close Long close_short Close Short
price	y	string	Price
amount	y	int	Amount
beMaker	n	int	Timestamp	0	Post-only：0:Not Post-only 1:Post-only
ioc	n	int	if orders cannot be immediately traded , the untranslated part will be cancelled immediately	0	0: Disable，1: Enable
tag	n	string	Tag		tags defined by the user at the time of order placing and returned after the order is placed

Parameter	Mandatory	Type	Description	Default Value	Value Range
id	y	long	Orderid

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

Parameter	Mandatory	Type	Description
amount	y	string	Amount
avgPrice	y	string	Avg. Filled Price
base	y	string	Base curreny,such as btc、fbtc
contractCode	y	string	A combination between Base and Quote P_BTC_USDT，R_BTC_USDT
contractDirection	y	int	FuturesSide 0: Linear,1: Inverse
createdDate	y	string	Creation Time
dealAmount	y	string	Filled Amount
detailSide	y	string	OrderSide 1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short
direction	y	string	Conditional：triggerSide，greater Greater，less Less
fee	y	string	The handling fee paid after the order is filled: Positive means fee obtained, negative means fee paid
id	y	long	Orderid
orderSize	y	string	Ordervalue
price	y	string	OrderPrice
profit	y	string	The P/L corresponding to the order after being filled: Positive means profit, negative means loss
quote	y	string	Quote currency name，usd,cny,usdt
reason	y	int	Reasons for cancellation of this order，0 is Default Value，no reasons
refConditionOrderId	y	long	ConditionalOrderid
refOrderCondition	y	object	ConditionalOrderDetails
side	y	string	OrderSide，longLong，shortShort
source	y	string	Source
status	y	int	Status 0:Waiting to fill 1:Partial filled 2:Filled -1:Cancelled
systemType	y	int	10:Limit 11:Market 13:Forced Liquidation 14: Liquidation 15：Over loss 16：ADL
triggerBy	y	string	ConditionaltriggerType，IndexPrice：index，MarkPrice：mark，LastPrice：last
triggerPrice	y	string	ConditionaltriggerPrice

Position API

Position List

GET /api/v1/perpetual/position/{contractCode}/list

Request Parameter：

Path Parameter

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

Query

Parameter	Mandatory	Type	Description	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp

Response

[
    {
        "id": "1001",
        "amount": "4867",
        "base": "fbtc",
        "closingAmount": "0",
        "contractCode": "fbtcusd",
        "lever": "100",
        "liqudatePrice": "3237.43",
        "maintenanceMargin": "0.02527905",
        "markPrice": "9659.25",
        "minQuoteDigit": 2,
        "minTradeDigit": 8,
        "openMargin": "0.14863957",
        "price": "9626.54",
        "quote": "usd",
        "realizedSurplus": "0.00413503",
        "side": "long",
        "size": "5.05581019",
        "type": 0
    }
]
  

Return：

Parameter	Mandatory	Type	Description
id	y	long	Position ID
amount	y	string	Amount
base	y	string	base currency name,example:BTC、ETH
closingAmount	y	int	Transaction Vol.
contractCode	y	string	Futures
gear	y	string	Risk limit
lever	y	string	Leverage
liqudatePrice	y	string	Liquidation price
maintenanceMargin	y	string	Maintenance margin
markPrice	y	string	Mark price
minQuoteDigit	y	string	Min. transaction decimal places of quote currency
minTradeDigit	y	string	Min. transaction decimal places of base currency
openMargin	y	string	Open margin
price	y	string	Avg.price
quote	y	string	quote currency name，USD,CNY,USDT
realizedSurplus	y	string	Realized P/L
side	y	string	PositionType，longLong，shortShort
size	y	string	PositionValue
type	y	string	0：Cross，1：Isolated

Obtain Margin Rate and Levers of All Tiers

GET /v1/perpetual/public/{contractCode}/lever-gears

example

Request Parameter：

Path Parameter

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

Query

Parameter	Mandatory	Type	Description	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp

Response

{
    "code": 200,
    "data": [
        {
            "entryRate": "0.008",
            "gear": 1,
            "lever": "125",
            "maintainRate": "0.004",
            "maxOpenAmount": "100"
        }
    ]
    "msg": "success"
}

  

Return：

Parameter	Mandatory	Type	Description
entryRate	y	string	Open margin rate
gear	y	int	tiers
lever	y	string	Leverage
maintainRate	y	string	Maintenance margin rate
maxOpenAmount	y	string	Max.Avail

Position and Limit Settings

GET /api/v1/perpetual/position/{contractCode}/configs

example

Request Parameter：

Path Parameter

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

Query

Parameter	Mandatory	Type	Description	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp

Response

{
  "contractCode": "btcusdt",
  "feeRate": "0.00065",
  "fundRate": "0.00375",
  "indexPrice": "37591.04",
  "longPositionConfigDetails": {
    "initOpenMarginRate": "0.008",
    "lever": "125",
    "maintainRate": "0.004",
    "maxOpenAmount": "100",
    "side": "long"
  },
  "makerFeeRate": "0.00035",
  "markPrice": "37704.1",
  "shortPositionConfigDetails": {
    "initOpenMarginRate": "0.008",
    "lever": "125",
    "maintainRate": "0.004",
    "maxOpenAmount": "100",
    "side": "short"
  },
  "takerFeeRate": "0.00065",
  "type": 0,
  "unitAmount": "0.01"
}
  

Return：

main

Parameter	Mandatory	Type	Description
contractCode	y	string	Futurescode
feeRate	y	int	Handling Fee Rate
fundRate	y	string	Fee Rate
indexPrice	y	string	Index price
markPrice	y	string	Mark price
type	y	string	0：Cross，1：Isolated
unitAmount	y	string	(Conts)：Number of quote face values for Futures (One cont)
makerFeeRate	y	string	maker Fee Rate
takerFeeRate	y	string	taker Fee Rate

longPositionConfigDetails

shortPositionConfigDetails

Position详情**

Parameter	Mandatory	Type	Description
lever	y	string	Leverage
side	y	string	Side
maxOpenAmount	y	string	Max.Avail
lever	y	string	Leverage
initOpenMarginRate	y	string	Initial margin rate

Set-up Leverage

POST /api/v1/perpetual/position/{contractCode}/lever

example

Request Parameter：

Path Parameter

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

Query

Parameter	Mandatory	Type	Description	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp

Body(json)

Parameter|Mandatory|Type|Description|Default Value|Value Range ————- | ————- | ————- | ————- | ————- | ————- type|y|int|LeverageType||Cross:0,Isolated:1 shortLever|y|int|ShortLeverage|| longLever|y|string|LongLeverage||

Response

{
    "code":200,
    "data":
    {
        "shortLever":26,
        "type":1,
        "longLever": 10
    },
    "msg":"success"
}
  

Return：

Parameter	Mandatory	Type	Description	Default Value	Value Range
lever	y	string	Leverage

Change Margin

POST /api/v1/perpetual/position/{contract_code}/change-margin

example

Request Parameter：

Path Parameter

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

Query

Parameter	Mandatory	Type	Description	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp
margin	y	string	Margin amount（A positive number indicates a margin increase, a negative number indicates a margin decrease）
side	y	string	Side	long Long short Short

Body(json)

{
}

Return：

Response

{
    "code": 200,
    "data": null,
    "msg": "success"
}
  

Parameter	Mandatory	Type	Description
code	y	int	Status，200：Success
msg	y	string	Tips
data	y	object

Set Automatic Margin

POST /api/v1/perpetual/position/{contractCode}/setting

example

Request Parameter：

Path Parameter

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

Query

Parameter	Mandatory	Type	Description	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method	HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp
value	y	string	1 Enable Auto-margin call；0-Disable Auto-margin call

Body(json)

{
}

Return：

Response

{
    "code": 200,
    "data": null,
    "msg": "success"
}
  

Parameter	Mandatory	Type	Description
code	y	int	Status，200：Success
msg	y	string	Tips
data	y	object