Hotcoin Global · Write an awesome description for your new site here. You can edit this line in

中文

Change Log # Change Log 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
Introduction # Introduction Welcome to Hotcoin Global API. This is the official Hotcoin API document, and will be continue updating. Hotcoin will also publish API announcement in advance for any API change. Please subscribe to our announcements so that you can get the latest updates. Below is the content for Spot API document: ### Access Instructions Before you use API, you need to login the website to create API Key with proper permissions. The API key is shared for all instruments in Hotcoin including spot, futures, swap, options. The permissions are described as follows: * **Read permission**:It is used to query the data, such as order query, trade query. * **Trade permission**:It is used to create order, cancel order and transfer, etc. * **Withdraw permission**:It is used to create withdraw order, cancel withdraw order, etc. ### Security Authentication AccessKey is the access key to API, SecretKey is the secret key of user signature for requests. Important note: These two keys are closely related to account security, and should not be disclosed to others at any time Demo [Java](https://github.com/hotcoinex/openapi/blob/master/ApiDemo.java) | [Python3](https://github.com/hotcoinex/openapi/blob/master/ApiDemo.py) | [Php](https://github.com/hotcoinex/openapi/blob/master/Demo.php) | [Dart](https://github.com/hotcoinex/openapi/blob/master/ApiOrderPlace.dart) ### Legal request structure Based on the consideration of security, all API request must be calculated by signature algorithm except market API. A legel request consists of below parts: - Request-URI Method, i.e. the address access to server: api.hotcoinfin.com followed by method name, take api.hotcoinfin.com/v1/order/place for instance. - API AccessKeyId is the The AccessKey in the APIKEY you requested. - Signature Method is the hash-based protocol of calculating signatures by users, HmacSHA256 is applied here. - SignatureVersion is the version of the signature protocol, 2 is applied here. - Timestamp is the time you made the request (UTC Time Zone). Including the value in query request helps preventing third parties from interception of your request. For example：2017-05-11T16:22:06.123Z.Again,(UTC Time Zone) is stressed here. For required parameters and optional parameters, these parameters and their meanings can be viewed in the description of each method. - Signature the value calculated by signature is used for ensuring that the signature is valid and not tampered. > https://api.hotcoinfin.com/v1/order/place? AccessKeyId=AccessKeyHotcoin123456789 &symbol=btc_usdt &type=buy &tradePrice=40000 &tradeAmount=0.1 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16:22:06.123Z &Signature=calculated value ### Signature Algorithm API request can be tempered at great risk while it is sent through the Internet. To ensure that the request is not tempered, we will require users to sign in every request (except market API) for verifying the authticity of parameters or the values of parameters. Sign Steps: Standards for Requests of Calculating Signatures: Establish a standard for requests of calculating signatures because when using HMAC to calculate signature, total different results will be achieved as different contents are calculated. So before calculating signatures, please make a standard. Examples of the request of order placement will be given as follows. >https://api.hotcoinfin.com/v1/order/place? AccessKeyId=AccessKeyHotcoin123456789 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16:22:06.123Z &symbol=btc_usdt &type=buy &tradePrice=40000 &tradeAmount=0.1 The request Method (GET or POST, WebSocket use GET), append line break "\n" GET\n The host with lower case, append line break \n. api.hotcoinfin.com\n. The path, append line break "\n" /v1/order/place\n Sorting parameters by order of ASCII code (Encoding by UTF-8 format and URI format, hexadecimal characters must be capitalized, for example ':' will be encoded as '%3A', space key will be encoded as '%20'). For example, here is the original order of the request parameters after encoded. >AccessKeyId=AccessKeyHotcoin123456789 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16:22:06.123Z &symbol=btc_usdt &type=buy &tradePrice=40000 &tradeAmount=0.1 Above parameter should be ordered like below: >AccessKeyId=AccessKeyHotcoin123456789 SignatureMethod=HmacSHA256 SignatureVersion=2 Timestamp=2017-05-11T16%3A22%3A06.123Z& symbol=btc_usdt tradeAmount=0.01 tradePrice=40000 type=buy Use char '&' to concatenate all parameters. >AccessKeyId=AccessKeyHotcoin123456789 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16%3A22%3A06.123Z &symbol=btc_usdt &tradeAmount=0.1 &tradePrice=40000 &type=buy The final strings for signature calculation is as follows: >GET\n api.hotcoinfin.com\n /v1/order/place\n AccessKeyId=AccessKeyHotcoin123456789 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16%3A22%3A06.123Z &symbol=btc_usdt &tradeAmount=0.1 &tradePrice=40000 &type=buy Calculation of signature algorithm, transfer the following two parameters to the cryptographic hash function: Strings for signature calculation >GET\n api.hotcoinfin.com\n /v1/order/place\n AccessKeyId=AccessKeyHotcoin123456789 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16%3A22%3A06.123Z &symbol=btc_usdt &tradeAmount=0.1 &tradePrice=40000 &type=buy SecretKey for execute signature SecretKeyHotcoin123456789 Obtained result of signature calculation and encoded with Base64 2oEC+yhkHTsNkgPUq4ZB/5mlY7EZAtUDWOQ5EO01D+I= Add the above values as the value of parameter Signature to the API request. The value must be encoded with URI when this parameter is added to the request. symbol rules：base currency + quote currency.In BTC/USDT, symbol is btc_usdt；While in ETH/BTC, symbol is eth_btc, and so on. Finally, the API request sent to the server should be： >https://api.hotcoinfin.com/v1/order/place ?AccessKeyId=AccessKeyHotcoin123456789 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2017-05-11T16%3A22%3A06.123Z &symbol=btc_usdt &tradeAmount=0.1 &tradePrice=40000&type=buy &Signature=2oEC%2ByhkHTsNkgPUq4ZB%2F5mlY7EZAtUDWOQ5EO01D%2BI%3D

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

Reference Data

Market Data # Market Data ### Real-time Ticker data Signature Authentication: No Rate Limit: 10 times/s - GET /v1/market/ticker ```json https://api.hotcoinfin.com/v1/market/ticker curl "https://api.hotcoinfin.com/v1/market/ticker" ``` **Response data:** Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- status|y|string|Status code||success：ok，failed：error timestamp|y|long|Current millisseconds|| ticker|y|list|data||
Response
```json { "status":"ok", "timestamp":1567045034, "ticker":[ { "symbol":"btc_usdt", "last":"10000.00000000", "buy":"9999.00000000", "sell":"10001.00000000", "high":"11000.00000000", "low":"9000.00000000", "vol":"10000000.0000", "change":"10.10" } ] } ``` Parameter|Mandatory| Data Type|Description|Default|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|| ### Obtain kline data Signature Authentication: No Rate Limit: 20 times/s - GET /v1/ticker ```json https://api.hotcoinfin.com/v1/ticker?symbol=btc_usdt&step=60 curl "https://api.hotcoinfin.com/v1/ticker?symbol=btc_usdt&step=60" ``` **Request parameters:** 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 **Response data:**
Response
```json { "code":200, "msg":"success", "time":1527838104874, "data":[ [ 1527820200000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ], [ 1527820200000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ] ] } ``` Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code msg|n|string|return message time|y|long|Current millisseconds data|y|array(array(number))|Kline data **data:**
[[
1527820200000, //int time
54598.5, //number O
54598.5, //number H
54598.5, //number L
54598.5, //number C
0.0000 //number Vol
],
......
]
### Obtain Deep Data Signature Authentication: No Rate Limit: 20 times/s - GET /v1/depth ```json https://api.hotcoinfin.com/v1/depth?symbol=btc_usdt&step=60 curl "https://api.hotcoinfin.com/v1/depth?symbol=btc_usdt&step=60" ``` **Request parameters:** 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,3*60,5*60,15*60,30*60,60*60（1h）,24*60*60（1d）,7*24*60*60（1w）,30*24*60*60（1mon） **Response data:**
Response
```json { "code":200, "msg":"success", "time":1527837164605, "data":{ "period":{ "data":[ [ 1527837120000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ] ], "marketFrom":"btc_usdt", "type":60, "coinVol":"btc_usdt" }, "depth":{ "date":1527837163, "asks":[ [ 57373.8, 0.0387 ], [ 57751.26, 0.0128 ], [ 57751.26, 0.0128 ] ], "bids":[ [ 57373.8, 0.0387 ], [ 57751.26, 0.0128 ], [ 57751.26, 0.0128 ] ], "lastPrice":54598.5 } } } ``` Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code msg|n|string|return message time|y|long|Current millisseconds data|y|object|Trading deep date **data:** Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- depth|y|object period|n|object|Vaule only displayed when uploading step **depth:** Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- 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 **period:** Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- 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 ### Obtain real-time trade data Signature Authentication: No Rate Limit: 20 times/s - GET /v1/trade ```json https://api.hotcoinfin.com/v1/trade?symbol=btc_usdt&count=60 curl "https://api.hotcoinfin.com/v1/trade?symbol=btc_usdt&count=60" ``` **Request parameters:** Parameter|Mandatory| Data Type|Description|Default|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 **Response data:**
Response
```json { "code":200, "msg":"success", "time":1536315868962, "data":{ "sellSymbol":"BTC", "buySymbol":"USDT", "trades":[ { "price":0.007, "amount":66491.04, "id":1, "time":"02:45:08", "en_type":"ask", "type":"sell" }, { "price":0.007, "amount":66491.04, "id":1, "time":"02:45:08", "en_type":"ask", "type":"sell" } ] } } ``` Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code msg|n|string|return message time|y|long|Current millisseconds data|y|object|Real-time transactions **data:** Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- trades|y|array(object)|trades data sellSymbol|y|string|sellSymbol buySymbol|y|string|buySymbol **trades:** Parameter|Mandatory| Data Type|Description|Default|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

Account

Asset API

My Assets

GET /api/v1/perpetual/account/assets/{contractCode}

example

Request Parameters：

Path Parameter

Parameter	Mandatory	Type	Description	Default	Value Range
contractCode	y	string	Contractcode

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

{
    "nextRewardTimestamp": 86400000,
    "accountRights": "211.73425366",
    "realizedSurplus": "-1996.67028101",
    "unRealizedSurplus": "0",
    "orderMargin": "111.32734888",
    "positionMargin": "55.30721388",
    "env": 0,
    "currencyCode": "usdt",
    "availableMargin": "45.09969088"
}
  

Return：

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

Assets

GET /api/v1/perpetual/account/assets

example

Request Parameters：

Query

Parameter|Mandatory|Type|Description|Default|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

[
  {
    "availableBalance": "9875.254090",
    "currencyCode": "USDT",
    "env": "0",
    "frozenBalance": "0.000000",
    "orderMargin": "15.823570",
    "positionMargin": "89.352729",
    "positionAccountRights": "10456.925390",
    "realizedSurplus": "583.993103",
    "unRealizedSurplus": "-15.505000"
  }
]
  

Return：

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

Transaction History

GET /api/v1/perpetual/bills/deal-record

example

Request Parameters：

Query

Parameter	Mandatory	Type	Description	Default	Value Range
AccessKeyId	y	string	Accesskey
SignatureVersion	y	string	Version
SignatureMethod	y	string	Signature Method		HmacSHA256
Signature	y	string	Signature
Timestamp	y	string	Timestamp
startDate	n	long	Start Date
endDate	n	long	End Date
contractCode	n	string	Contractcode
page	n	integer	Page	1
pageSize	n	integer	PageSize	20
startId	n	long	Startid
endId	n	long	Endid

Response

{
    "code": 200,
    "data": {
        "data": [
            {
                "amount": "6",
                "contractCode": "btcusdt",
                "createDate": "2021-11-14 20:52:03",
                "currencyCode": "usdt",
                "dealType": 1,
                "detailSide": "close_long",
                "fee": "1.3579752900000000",
                "id": "666746374653476864",
                "makerTaker": "maker",
                "orderId": 125090120907072,
                "price": "64665.4900000000000000",
                "profit": "0.9555748956901509",
                "refOrderId": 125090122965326,
                "size": "3879.9294000000000000",
                "userId": "2000011"
            }
        ],
        "pageNum": 1,
        "pageSize": 20,
        "totalCount": 112677
    },
    "msg": "success"
}

  

Return：

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

基础信息

获取所有交易对

签名认证：否
限频值：10次/s

https://api.hotcoinfin.com/v1/common/symbols

curl "https://api.hotcoinfin.com/v1/common/symbols"

GET /v1/common/symbols

请求参数:
此接口不接受任何参数。 响应数据:

参数名称	是否必须	类型	描述	取值范围
code	y	int	状态码	成功：200
msg	y	string	消息
time	y	long	当前毫秒数
data	y	array	symbols列表

data:

Response

{
   "code": "200",
   "time": 1567045034,
   "data": [
   {"baseCurrency":"etc",
    "quoteCurrency":"usdt",
    "pricePrecision":6,
    "amountPrecision":4,
    "symbolPartition":"main",
    "symbol":"etc_usdt",
    "state":"online",
    "minOrderCount":0.001,
    "maxOrderCount":10000,
    "minOrderPrice":0.0001,
    "maxOrderPrice":10000
    },
    {
    "baseCurrency":"ltc",
    "quoteCurrency":"usdt",
    "pricePrecision":6,
    "amountPrecision":4,
    "symbolPartition":"innovation",
    "symbol":"ltc_usdt",
    "state":"online",
    "minOrderCount":0.001,
    "maxOrderCount":10000,
    "minOrderPrice":0.0001,
    "maxOrderPrice":10000
    }
  ]
}
  

字段类型	数据类型	描述	description（英文）
baseCurrency	string	交易中的基础币种	baseCurrency code
quoteCurrency	string	交易中的报价币种	quoteCurrency code
pricePrecision	integer	交易对报价的精度（小数点后位数）	price precision
amountPrecision	integer	交易对基础币种计数精度（小数点)	quantity precision
symbolPartition	string	交易区，可能值: [main,innovation]	symbol Partition, example:[main,innovation]
symbol	string	交易对	trade pair code
state	string	交易对状态 enable - 正常；disable-禁用	trade pair status [enable,disable]
minOrderCount	decimal	交易对最小下单量 (下单量指当订单类型为限价单时，下单接口传的’tradeAmount’)	min order count
maxOrderCount	decimal	交易对最大下单量 (下单量指当订单类型为限价单时，下单接口传的’tradeAmount’)	max order count
minOrderPrice	decimal	最小下单价格（下单金额指当订单类型为限价单时，下单接口传入的‘price’）	min order price
maxOrderPrice	decimal	最大下单价格（下单金额指当订单类型为限价单时，下单接口传入的‘price’）	max order price

行情数据 # 行情数据 ### 实时ticker数据签名认证：否限频值：10次/s - GET /v1/market/ticker ```json https://api.hotcoinfin.com/v1/market/ticker curl "https://api.hotcoinfin.com/v1/market/ticker" ``` **响应数据:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- status|y|string|状态码||成功：ok，失败：error timestamp|y|long|当前毫秒数|| ticker|y|list|数据||
Response
```json { "status":"ok", "timestamp":1567045034, "ticker":[ { "symbol":"btc_usdt", "last":"10000.00000000", "buy":"9999.00000000", "sell":"10001.00000000", "high":"11000.00000000", "low":"9000.00000000", "vol":"10000000.0000", "change":"10.10" } ] } ``` 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- symbol|y|string|交易对symbol||卖币种简称_买币种简称简称，eg：btc_usdt last|y|number|最新价|| buy|y|number|买一价|| sell|y|number|卖一价|| high|y|number|24小时最高价 || low|y|number|24小时最低价|| vol|y|number|24小时成交量|| change|y|number|24小时涨跌幅|| ### 获取k线数据签名认证：否限频值：20次/s - GET /v1/ticker ```json https://api.hotcoinfin.com/v1/ticker?symbol=btc_usdt&step=60 curl "https://api.hotcoinfin.com/v1/ticker?symbol=btc_usdt&step=60" ``` **请求参数:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- step|y|int|时间：秒||60（1分钟）,300（5分钟）,900（15分钟）,1800（30分钟）,3600（1小时）,86400（1天）,604800（1周）,2592000（1月） symbol|y|string|交易对||例：btc_usdt **响应数据:**
Response
```json { "code":200, "msg":"成功", "time":1527838104874, "data":[ [ 1527820200000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ], [ 1527820200000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ] ] } ``` 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|状态码 msg|n|string|返回消息 time|y|long|当前毫秒数 data|y|array(array(number))|K线数据 **data:**
[[
1527820200000, //int 时间
54598.5, //number 开
54598.5, //number 高
54598.5, //number 低
54598.5, //number 收
0.0000 //number 量
],
......
]
### 获取深度数据签名认证：否限频值：20次/s - GET /v1/depth ```json https://api.hotcoinfin.com/v1/depth?symbol=btc_usdt&step=60 curl "https://api.hotcoinfin.com/v1/depth?symbol=btc_usdt&step=60" ``` **请求参数:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- symbol|y|string|交易对||例：btc_usdt step|n|int|加上此参数可查最新一个k线数据，类型为时间，单位秒||60,3*60,5*60,15*60,30*60,60*60（1小时）,24*60*60（1天）,7*24*60*60（1周）,30*24*60*60（1月） **响应数据:**
Response
```json { "code":200, "msg":"成功", "time":1527837164605, "data":{ "period":{ "data":[ [ 1527837120000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ] ], "marketFrom":"btc_usdt", "type":60, "coinVol":"btc_usdt" }, "depth":{ "date":1527837163, "asks":[ [ 57373.8, 0.0387 ], [ 57751.26, 0.0128 ], [ 57751.26, 0.0128 ] ], "bids":[ [ 57373.8, 0.0387 ], [ 57751.26, 0.0128 ], [ 57751.26, 0.0128 ] ], "lastPrice":54598.5 } } } ``` 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|状态码 msg|n|string|返回消息 time|y|long|当前毫秒数 data|y|object|交易深度数据 **data:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- depth|y|object period|n|object|传step时才有值 **depth:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- bids|y|array(array(long))|买盘,[price(成交价), amount(成交量)] asks|y|array(array(long))|卖盘,[price(成交价), amount(成交量)] date|y|long|时间戳 lastPrice|y|number|最新成交价 **period:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- marketFrom|y|string|入参symbol coinVol|y|string|入参symbol type|y|long|入参step,时间 data|y|array（array）|最后一个k线数据，格式同上，但只有一个 ### 获取实时成交数据签名认证：否限频值：20次/s - GET /v1/trade ```json https://api.hotcoinfin.com/v1/trade?symbol=btc_usdt&count=60 curl "https://api.hotcoinfin.com/v1/trade?symbol=btc_usdt&count=60" ``` **请求参数:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- count|y|int|Trades条数||0 symbol|y|string|交易对||例：btc_usdt **响应数据:**
Response
```json { "code":200, "msg":"成功", "time":1536315868962, "data":{ "sellSymbol":"BTC", "buySymbol":"USDT", "trades":[ { "price":0.007, "amount":66491.04, "id":1, "time":"02:45:08", "en_type":"ask", "type":"卖出" }, { "price":0.007, "amount":66491.04, "id":1, "time":"02:45:08", "en_type":"ask", "type":"卖出" } ] } } ``` 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|状态码 msg|n|string|返回消息 time|y|long|当前毫秒数 data|y|object|实时成交数据 **data:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- trades|y|array(object)|trades数据 sellSymbol|y|string|sellSymbol buySymbol|y|string|buySymbol **trades:** 参数名称|是否必须|类型|描述|默认值|取值范围 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- price|y|long|成交价钱 amount|y|string|成交数量 id|y|string|成交id time|y|string|成交时间 en_type|y|string|成交方向||"bid"(买入),"ask"(卖出) type|y|string|成交类型||"买入","卖出"

参数名称	是否必须	类型	描述
code	y	int	状态码
msg	n	string	返回消息
time	y	long	当前毫秒数
data	y	object	交易深度数据

参数名称	是否必须	类型	描述
netassets	y	number	净资产，单位为usdt
totalassets	y	number	总资产，单位为usdt
wallet	y	array(object)	钱包列表

参数名称	是否必须	类型	描述
coinName	y	long	币种名称
uid	y	int	用户ID
coinId	y	int	币种ID
total	y	number	可用
frozen	y	number	冻结
symbol	y	string	币种symbol
shortName	y	string	币种简称

账户相关

资产接口

我的资产

GET /api/v1/perpetual/account/assets/{contractCode}

示例

请求参数：

路径参数

参数名称	是否必须	类型	描述	默认值	取值范围
contractCode	y	string	合约code

Query

参数名称	是否必须	类型	描述	取值范围
AccessKeyId	y	string	访问key
SignatureVersion	y	string	版本
SignatureMethod	y	string	签名方法	HmacSHA256
Signature	y	string	签名
Timestamp	y	string	时间戳

Response

{
    "nextRewardTimestamp": 86400000,
    "accountRights": "211.73425366",
    "realizedSurplus": "-1996.67028101",
    "unRealizedSurplus": "0",
    "orderMargin": "111.32734888",
    "positionMargin": "55.30721388",
    "env": 0,
    "currencyCode": "usdt",
    "availableMargin": "45.09969088"
}
  

参数名称	是否必须	类型	描述
currencyCode	y	string	币种
env	y	int	是否测试币 0:线上币,1:测试币
availableMargin	y	string	可用保证金
realizedSurplus	y	string	已实现盈亏
orderMargin	y	string	委托保证金
positionMargin	y	string	仓位保证金
unRealizedSurplus	y	string	未实现盈亏
accountRights	y	string	账户权益

资产列表

GET /api/v1/perpetual/account/assets

示例

请求参数：

Query

参数名称	是否必须	类型	描述	取值范围
AccessKeyId	y	string	访问key
SignatureVersion	y	string	版本
SignatureMethod	y	string	签名方法	HmacSHA256
Signature	y	string	签名
Timestamp	y	string	时间戳

Response

[
  {
    "availableBalance": "9875.254090",
    "currencyCode": "USDT",
    "env": "0",
    "frozenBalance": "0.000000",
    "orderMargin": "15.823570",
    "positionMargin": "89.352729",
    "positionAccountRights": "10456.925390",
    "realizedSurplus": "583.993103",
    "unRealizedSurplus": "-15.505000"
  }
]
  

参数名称	是否必须	类型	描述
availableBalance	y	string	可用余额
currencyCode	y	string	币种
env	y	int	是否测试币 0:线上币,1:测试币
frozenBalance	y	string	可用冻结（出现在划转审核）
orderMargin	y	string	订单保证金
positionMargin	y	string	仓位保证金
positionAccountRights	y	string	账户权益
realizedSurplus	y	string	已实现盈亏
unRealizedSurplus	y	string	未实现盈亏

成交记录

GET /api/v1/perpetual/bills/deal-record

示例

请求参数：

Query

参数名称	是否必须	类型	描述	默认值	取值范围
AccessKeyId	y	string	访问key
SignatureVersion	y	string	版本
SignatureMethod	y	string	签名方法		HmacSHA256
Signature	y	string	签名
Timestamp	y	string	时间戳
startDate	n	long	开始时间
endDate	n	long	结束时间
contractCode	n	string	合约code
page	n	integer	页数	1
pageSize	n	integer	每页数量	20
startId	n	long	开始id
endId	n	long	结束id

Response

{
    "code": 200,
    "data": {
        "data": [
            {
                "amount": "6",
                "contractCode": "btcusdt",
                "createDate": "2021-11-14 20:52:03",
                "currencyCode": "usdt",
                "dealType": 1,
                "detailSide": "close_long",
                "fee": "1.3579752900000000",
                "id": "666746374653476864",
                "makerTaker": "maker",
                "orderId": 125090120907072,
                "price": "64665.4900000000000000",
                "profit": "0.9555748956901509",
                "refOrderId": 125090122965326,
                "size": "3879.9294000000000000",
                "userId": "2000011"
            }
        ],
        "pageNum": 1,
        "pageSize": 20,
        "totalCount": 112677
    },
    "msg": "success"
}

  

参数名称	是否必须	类型	描述
amount	y	string	成交数量
contractCode	y	string	合约code
createDate	y	string	创建时间
currencyCode	y	string	币种
dealType	y	string	成交类型，1：自成交，2：与其他用户成交
detailSide	y	string	开平方向
fee	y	string	手续费
id	y	long	成交记录id
makerTaker	y	string	maker or taker
orderId	y	long	订单id
price	y	string	成交价格
profit	y	string	收益
refOrderId	y	long	关联订单id
size	y	string	成交价值
userId	y	long	uid

json