Spot
现货

中文

Change Log # Change Log Release Time(UTC +8)|API|Initialize / Update|Description | ------------- | ------------- | ------------- | ------------- | 2018.6.10|- |Initialize|Initializes the current version of the interface
Introduction # Introduction Welcome to Hotcoin 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 Huobi 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) ### 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: hkapi.hotcoin.top followed by method name, take hkapi.hotcoin.top/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_gavc &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_gavc &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_gavc &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_gavc 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_gavc &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_gavc &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_gavc &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_gavc &tradeAmount=0.1 &tradePrice=40000&type=buy &Signature=2oEC%2ByhkHTsNkgPUq4ZB%2F5mlY7EZAtUDWOQ5EO01D%2BI%3D
Reference Data # Reference Data ### Get all trade pairs ```json https://hkapi.hotcoin.top/v1/common/symbols curl "https://hkapi.hotcoin.top/v1/common/symbols" ``` - GET /v1/common/symbols **Request parameters:** **Response data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code||success：200 msg|y|string|message|| time|y|long|Current millisseconds|| data|y|array|symbols list|| **data:** ```json { "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 } ] } ``` 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
Market Data # Market Data ### Real-time Ticker data - GET /v1/market/ticker ```json https://hkapi.hotcoin.top/v1/market/ticker curl "https://hkapi.hotcoin.top/v1/market/ticker" ``` **Request parameters:** 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 data:** ```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 - GET /v1/ticker ```json https://hkapi.hotcoin.top/v1/ticker?symbol=btc_usdt&step=60 curl "https://hkapi.hotcoin.top/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_gavc **Response data:** ```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 - GET /v1/depth ```json https://hkapi.hotcoin.top/v1/depth?symbol=btc_usdt&step=60 curl "https://hkapi.hotcoin.top/v1/depth?symbol=btc_usdt&step=60" ``` **Request parameters:** Parameter|Mandatory| Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- symbol|y|string|Trading pair||Example：btc_gavc 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:** ```json { "code":200, "msg":"success", "time":1527837164605, "data":{ "period":{ "data":[ [ 1527837120000, 54598.5, 54598.5, 54598.5, 54598.5, 0 ] ], "marketFrom":"btc_gavc", "type":60, "coinVol":"btc_gavc" }, "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 data - GET /v1/trade ```json https://hkapi.hotcoin.top/v1/trade?symbol=btc_usdt&count=60 curl "https://hkapi.hotcoin.top/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_gavc **Response data:** ```json { "code":200, "msg":"success", "time":1536315868962, "data":{ "sellSymbol":"BTC", "buySymbol":"GAVC", "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"

Trading # Trading ### Place order - POST /v1/order/place **Request parameters:** 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|| **Response data:** ```json { "code":200, "msg":"order success", "time":1536306331399, "data":{ "ID":18194813 } } ``` Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code||success：200，failed：300 msg|y|string|message|| time|y|long|Current millisseconds|| data|y|object|data|| **msg range** English | | ------------ |Illegal request | Illegal tradeAmount value | Illegal tradePrice value | Illegal symbol format **data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- ID|y|bigint|order id|| ### Order Cancel Note:Cancel order requests is under asynchronous pattern,call interface /v1/order/detailById is required for order status query. - POST /v1/order/cancel **Request parameters:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- id|y|bigint |Order id | | **Response data:** ```json { "code": 200, "msg": "Cancel Success", "time": 1536306495984, "data": null } ``` Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code||success：200，failed：300 msg|y|string|message|| time|y|long|Current millisseconds|| ### Order Details - GET /v1/order/detailById ```json https://hkapi.hotcoin.top/v1/order/detailById curl "https://hkapi.hotcoin.top/v1/order/detailById" ``` **Request parameters:** 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| | **Response data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code|| msg|n|string|message|| time|y|long|Current millisseconds|| data|y|object|order details|| **data:** ```json { "code": 200, "msg": "success", "time": 1536306896294, "data": { "types": "bug", "leftcount": 0.01, "fees": 0, "last": 0, "count": 0.01, "successamount": 0, "source": "API", "type": 0, "price": 40000, "buysymbol": "", "id": 18194814, "time": "2018-09-07 15:48:44", "sellsymbol": "", "statusCode":1, "status": "unsettled" } } ``` Parameter|Mandatory|Data Type|Description|Default|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 ### Transaction details - GET /v1/order/counterpartiesById ```json https://hkapi.hotcoin.top/v1/order/counterpartiesById curl "https://hkapi.hotcoin.top/v1/order/counterpartiesById" ``` **Request parameters:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- id|y|bigint |order id | | **Response data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code|| msg|n|string|message|| time|y|long|Current millisseconds|| data|y|object|Order detail|| **data:** ```json { "code":200, "data":{ "entrusts":[ { "amount":1.2042000000, "count":2.2300000000, "createTime":"2019-05-27 18:15:12", "entrustId":431879850, "entrustType":0, "id":101192723, "isSelfTrade":1, "matchId":431879852, "prize":0.5400000000, "sysmbol":"btc_gavc" } ] }, "msg":"success", "time":1568690580787 } ``` Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- entrusts|y|array(object)|BBO list|| **wallet:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- 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|| ### Obtain order list - GET /v1/order/entrust ```json https://hkapi.hotcoin.top/v1/order/entrust curl "https://hkapi.hotcoin.top/v1/order/entrust" ``` **Request parameters:** 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 **Response data:** ```json { "code": 200, "msg": "Obtain success！", "time": 1527841588334, "data":{ "entrutsHis": [ { "types": "Buy", "leftcount": 1.0E-4, "fees": 0, "last": 0, "count": 1.0E-4, "successamount": 0, "source": "WEB", "type": 1, "price": 1.0E7, "buysymbol": "GAVC", "id": 947644, "time": "2018-06-27 17:45:14", "sellsymbol": "BTC", "status": "Cancelled" }, { "types": "Buy", "leftcount": 1.0E-4, "fees": 0, "last": 0, "count": 1.0E-4, "successamount": 0, "source": "WEB", "type": 1, "price": 1.0E7, "buysymbol": "GAVC", "id": 947645, "time": "2018-06-27 17:45:14", "sellsymbol": "BTC", "status": "Cancelled" } ], "entrutsCur": [ { "types": "Buy", "leftcount": 0.01, "fees": 0, "last": 0, "count": 0.01, "successamount": 0, "source": "API", "type": 0, "price": 40000, "buysymbol": "GAVC", "id": 18194814, "time": "2018-09-07 15:48:44", "sellsymbol": "BTC", "status": "Unfill" }, { "types": "Sell", "leftcount": 0.01, "fees": 0, "last": 0, "count": 0.01, "successamount": 0, "source": "API", "type": 0, "price": 40000, "buysymbol": "GAVC", "id": 18194814, "time": "2018-09-07 15:48:44", "sellsymbol": "BTC", "status": "Unfill" } ] } } ``` 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|Order details|| **data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- entrutsCur|n|array(object)|Current order|| entrutsHis|n|array(object)|History order|| **entrutsCur 及 entrutsHis Data Type is the same:** Parameter|Mandatory|Data Type|Description|Default|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 ### Current&History Transaction Record - GET /v1/order/matchresults ```json https://hkapi.hotcoin.top/v1/order/matchresults curl "https://hkapi.hotcoin.top/v1/order/matchresults" ``` **Request parameters:** 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 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] **Response data:** ```json { "code":200, "data":{ "entrustdetail":[ { "createdAt":1623134000577, "filledAmount":"1.20", "filledFees":"2.2300", "id":43187, "matchId":123456, "orderId":431879852, "type":"1", "price":"0.5400000000", "role":"taker" } ] }, "msg":"success", "time":1568690580787 } ``` 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 ------------- | ------------- | ------------- | ------------- | ------------- | ------------- entrustdetail|n|array(object)|Transaction Record **entrustdetail:** Parameter|Mandatory|Data Type|Description|Default|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 ### Batch Cancels - POST /v1/order/batchCancelOrders `Note： The API only for submit cancel request,actual result need to confirm by order Status,matchmaking Status.` **Request parameters:** 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" **Response data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code msg|n|string|Return message data|y|object| ### Batch Cancels(OpenOrders) - POST /v1/order/batchCancelOpenOrders `Note： The API only for submit cancel request,actual result need to confirm by order Status,matchmaking Status.` **Request parameters:** 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. **Response data:** ```json { "code":200, "data":{ "successCount": 1, "failCount": 1 }, "msg":"success" } ``` Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code msg|n|string|Return message data|y|object| **data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- {successCount|y|int|Success cancel amount failCount}|y|int|Cancelled failed amount ### Batch Orders API Key Access：Trading,Maximum 10 orders for a single batch - POST /v1/order/batchOrders **Request parameters:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- orders|y|object|Order list|| **orders:** 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|| **Response data:** ```json { "code": 200, "msg": "success", "time": 1527841588334, "data":{ "list": [ { "ID":123456, "errcode": "", "errmsg": "" }, { "ID":1234567, "errcode": "", "errmsg": "" } ] } } ``` Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- code|y|int|Status code msg|n|string|Return message data|y|object| **data:** Parameter|Mandatory|Data Type|Description|Default|Value Range ------------- | ------------- | ------------- | ------------- | ------------- | ------------- [{ID|y|bigint|Order id|| errcode|n|string|return error code errmsg}]|n|string|Return error Description

Account

Obtain User Balance

GET /v1/balance

https://hkapi.hotcoin.top/v1/balance?AccessKeyId=""

curl "https://hkapi.hotcoin.top/v1/balance?AccessKeyId=''"

Request parameters:

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

Response data:

{
   "code": 200,
   "msg": "success",
   "time": 1527835756743,
   "data":    {
      "netassets": 0,
      "wallet": [
         {
			"uid":1100011,
			"coinId":1,
			"symbol":"BTC",
			"total":1000.0000000000,
			"frozen":1000.0000000000,
			"coinName":"BTC",
			"shortName":"BTC"
		},
		{
			"uid":1100011,
			"coinId":2,
			"symbol":"LTC",
			"total":1000.0000000000,
			"frozen":1000.0000000000,
			"coinName":"LTC",
			"shortName":"LTC"
		},
		{
			"uid":1100011,
			"coinId":4,
			"symbol":"ETH",
			"total":1000.0000000000,
			"frozen":0E-10,
			"coinName":"ETH",
			"shortName":"ETH"
		}
      ],
      "totalassets": 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	object	Transaction deep data

data:

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

wallet:

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

json