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

WebSocket行情数据

接入说明

WebSocket域名

wss://wss.hotcoinfin.com/trade/multiple

数据压缩

WebSocket行情接口返回的所有数据进行了GZIP压缩，客户端在收到数据之后需要解压。

心跳消息

当用户的Websocket客户端连接到热币服务器后，热币服务器会定期（当前设为5秒）向其发送ping消息，如下： {"ping": "ping"}

当用户的Websocket客户端接收到此心跳消息后，应返回pong消息，如下： {"pong": "pong"}

订阅主题

成功建立与Websocket服务器的连接后，Websocket客户端发送请求以订阅特定主题： {"sub": "topic to subscribe"}

比如：{"sub": "market.btc_usdt.trade.depth"}

成功订阅后，Websocket客户端将收到确认消息：

Response

    {
      "ch": "market.btc_usdt.trade.depth",
      "code": 200,
      "msg": "SUCCESS",
      "status": "ok",
      "ts": 1632878832006
    }
  

之后, 一旦所订阅的主题有数据更新，热币服务器将向Websocket客户端推送更新消息。

取消订阅

取消订阅的格式如下：{"unsub": "topic to unsubscribe"}

取消订阅成功确认。

K线数据

请求数据：{"sub":"market.$symbol$.kline.$period$"}

取消订阅：{"unsub":"market.$symbol$.kline.$period$"}

参数说明

参数	数据类型	是否必须	描述	备注
symbol	String	是	交易代码	btc_usdt
period	String	是	k线周期	1m,5m,15m,30m,1h,2h,4h,6h,12h,1d,3d,5d,1w,1mo

订阅成功或者取消订阅后，服务器返回数据:

Response

    {
        "ch": "market.btc_usdt.kline.1m",
        "code": 200,
        "code": 200,
        "msg": "SUCCESS",
        "status": "ok",
        "ts": 1489474081631
    }
  

返回字段说明:

[时间,开盘价,最高价,最低价,收盘价,成交量]

[ts, open, high, low, close, vol]

参数	数据类型	是否必填	描述	备注
ts	String	是	时间	时间有效范围[1501174800000, 2556115200000]
open	String	是	开盘价	995.37
high	String	是	最高价	996.75
low	String	是	最低价	995.36
close	String	是	收盘价	996.75
vol	String	是	交易量	9.112

市场深度数据

请求数据：{"sub":"market.$symbol$.trade.depth"}

取消订阅：{"unsub":"market.$symbol$.trade.depth"}

参数说明

参数	数据类型	是否必须	描述	备注
symbol	String	是	交易代码	btc_usdt

订阅成功或者取消订阅后，服务器返回数据:

Response

    {
        "ch": "market.btc_usdt.trade.depth",
        "code": 200,
        "msg": "SUCCESS",
        "status": "ok",
        "ts": 1489474081631
    }
  

返回字段说明:

参数	数据类型	是否必填	描述	默认值
bids	[String,String]	是	【买方价格,买方深度量】	["9999.39","0.0098"]
asks	[String,String]	是	【卖方价格,卖方深度度量】	["10010.98","0.0099"]
last	String	是	最新价	0
open	String	是	开盘价	0
cny	String	是	折合人民币价格	0
netValue	String	是	ETF净值	0
buyOrSellCnyPrice	String	是	买入或者卖出人民币估值时使用	0

买一卖一逐笔行情

请求数据： {"sub":"market.$symbol$.trade.bbo"}

取消订阅：{"unsub":"market.$symbol$.trade.bbo"}

参数说明

参数	数据类型	是否必须	描述	备注
symbol	String	是	交易代码	btc_usdt

订阅成功或者取消订阅后，服务器返回数据:

Response

    {
        "ch": "market.btc_usdt.trade.bbo",
        "code": 200,
        "msg": "SUCCESS",
        "status": "ok",
        "ts": 1489474081631
    }
  

返回字段说明:

参数	数据类型	是否必填	描述	默认值
symbol	String	是	交易代码	btc_usdt
bid	String	是	买一价	0
bidSize	String	是	买一量	0
ask	String	是	卖一价	0
askSize	String	是	卖一量	0
last	String	是	最新价	0

24H聚合行情数据

请求数据：{"sub":"market.$symbol$.24h.tickers"}

取消订阅：{"unsub":"market.$symbol$.24h.tickers"}

参数说明

参数	数据类型	是否必须	描述	备注
symbol	String	是	交易代码	btc_usdt

订阅成功或者取消订阅后，服务器返回数据:

Response

    {
        "ch": "market.btc_usdt.24h.tickers",
        "code": 200,
        "msg": "SUCCESS",
        "status": "ok",
        "ts": 1489474081631
    }
  

返回字段说明:

参数	数据类型	是否必填	描述
sellShortName	String	是	卖方币种简称:BTC
sellSymbol	String	是	卖方币种全称:bitcoin
buyShortName	String	是	买方币种简称:ETH
buySymbol	String	是	买方币种全称:ethereum
high	String	是	最高价
open	String	是	开盘价
low	String	是	最低价
close	String	是	收盘价
volume	String	是	交易量
change	String	是	涨跌幅
cny	String	是	折合人民币的最新价
tradeId	Integer	是	交易代码ID
last	String	是	最新价(原始价格)
imageUrl	String	是
netValue	String	否	ETF净值

实时成交明细

请求数据：{"sub":"market.$symbol$.trade.detail"}

取消订阅：{"unsub":"market.$symbol$.trade.detail"}

参数说明

参数	数据类型	是否必须	描述	备注
symbol	String	是	交易代码	btc_usdt

订阅成功或者取消订阅后，服务器返回数据:

Response

    {
        "ch": "market.btc_usdt.trade.detail",
        "code": 200,
        "msg": "SUCCESS",
        "status": "ok",
        "ts": 1489474081631
    }
  

返回字段说明:

参数	数据类型	是否必填	默认值	描述
amount	String	是	成交量	0.0099
ts	String	是	成交时间	有效时间范围[1501174800000, 2556115200000]
tradeId	Integer	是	交易代码ID	交易代码ID
price	String	是	成交价格	401.74
direction	String	是	买单【buy】或卖单【sell】	[buy/sell]

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