API Referrence

1. Overview of market data for all tickers

API : Summary of all tickers

Endpoint : https://app.hotbtc.exchange/api/live/marketData

REQUEST TYPE : GET

Sample Response:

            
            {
            "code": 200,
            "msg": "success",
            "data": {
                "BTC_ETH": {
                    "id": 1,
                    "last": 0.026221,
                    "lowestAsk": 0.026092,
                    "highestBid": 0,
                    "percentChange": 0,
                    "baseVolume": 0,
                    "quoteVolume": 0,
                    "isFrozen": 0,
                    "high24hr": 0,
                    "low24hr": 0
                    },
                "BTC_XRP": {
                    "id": 2,
                    "last": 2.66e-5,
                    "lowestAsk": 2.661e-5,
                    "highestBid": 0,
                    "percentChange": 0.0003760812335463787,
                    "baseVolume": 0.00098387,
                    "quoteVolume": 37,
                    "isFrozen": 0,
                    "high24hr": 2.66e-5,
                    "low24hr": 2.659e-5
                    }
                }
            }

Error Response :

  • {"code":204,"msg":"No data found"}
  • {"code":500,"msg":"Some Error Occurred ! Please Try again!!"}

2. List of crypto currencies available on the exchange

API : ASSETS

Endpoint : https://app.hotbtc.exchange/api/live/assets

REQUEST TYPE : GET

Sample Response :

            
            {
                "code": 200,
                "msg": "success",
                "data": {
                    "BTC": {
                        "name": "Bitcoin",
                        "unified_cryptoasset_id": "1",
                        "can_withdraw": true,
                        "can_deposit": true,
                        "min_withdraw": 0.0015,
                        "max_withdraw": 1,
                        "maker_fee": "0",
                        "taker_fee": "0"
                    },
                    "ETH": {
                        "name": "Etherium",
                        "unified_cryptoasset_id": "1027",
                        "can_withdraw": true,
                        "can_deposit": true,
                        "min_withdraw": 0.02,
                        "max_withdraw": 20,
                        "maker_fee": "0",
                        "taker_fee": "0"
                    }
                }
            }

Assets response descriptions.

Name Type Status Description
name string Recommended Full name of cryptocurrency.
unified_cryptoasset_id integer Recommended Unique ID of cryptocurrency assigned by Unified Cryptoasset ID.
can_withdraw boolean Recommended Identifies whether withdrawals are enabled or disabled.
can_deposit boolean Recommended Identifies whether deposits are enabled or disabled.
min_withdraw decimal Recommended Identifies the single minimum withdraw amount of a cryptocurrency.
max_withdraw decimal Recommended Identifies the single maximum withdraw amount of a cryptocurrency.
maker_fee decimal Recommended Fees applied when liquidity is added to the order book.
taker_fee decimal Recommended Fees applied when liquidity is removed from the order book.

Error Response :

  • {"code":204,"msg":"No data found"}
  • {"code":500,"msg":"Some Error Occurred ! Please Try again!!"}

3. 24-hour pricing and volume summary for each market pair on the exchange

API : TICKER

Endpoint : https://app.hotbtc.exchange/api/live/ticker

REQUEST TYPE : GET

Sample Response :

            
            {
                "code": 200,
                "msg": "success",
                "data": {
                    "BTC_ETH": {
                        "base_id": "1",
                        "quote_id": "1027",
                        "last_price": 0.026221,
                        "baseVolume": 0,
                        "quoteVolume": 0,
                        "isFrozen": 0
                    },
                    "BTC_XRP": {
                        "base_id": "1",
                        "quote_id": "52",
                        "last_price": 2.66e-5,
                        "baseVolume": 0.00098387,
                        "quoteVolume": 37,
                        "isFrozen": 0
                    }
                }
            }

Ticker response descriptions.

Name Type Status Description
base_id integer Recommended The quote pair Unified Cryptoasset ID.
quote_id integer Recommended The base pair Unified Cryptoasset ID.
last_price decimal Mandatory The price of the last executed order
base_volume decimal Mandatory 24 hour trading volume in base pair volume
quote_volume decimal Mandatory 24 hour trading volume in quote pair volume
isFrozen integer Recommended Indicates if the market is currently enabled (0) or disabled (1).

Error Response :

  • {"code":204,"msg":"No data found"}
  • {"code":500,"msg":"Some Error Occurred ! Please Try again!!"}

4. Orderbook

API : ORDERBOOK

Endpoint : https://app.hotbtc.exchange/api/live/orderbook/{ market_pair }

REQUEST TYPE : GET

Sample Response :

            
            {  
                "timestamp":"1566359163",
                "bids":[  
                    [  
                        "12462000",
                        "0.04548320"
                    ]
                ],
                "asks":[  
                    [  
                        "12506000",
                        "2.73042000"
                    ],
                    [  
                        "12508000",
                        "0.33660000"
                    ]
                ]
            }

Parameters :

Name Type Status Description
market_pair string Mandatory A pair such as “LTC_BTC”

Order book response descriptions. :

Name Type Status Description
timestamp timestamp Mandatory Unix timestamp in milliseconds for when the last updated time occurred.
bids decimal Mandatory An array containing 2 elements. The offer price and quantity for each bid order.
asks decimal Mandatory An array containing 2 elements. The ask price and quantity for each ask order.

Error Response :

  • {"code":204,"msg":"No data found"}
  • {"code":500,"msg":"Some Error Occurred ! Please Try again!!"}
    • -->

5. Recently completed Trades For a Given Market

API : TRADES

Endpoint : https://app.hotbtc.exchange/api/live/trades/{market_pair}/{type/side}

REQUEST TYPE : GET

Sample Response :

            
            [
                {
                    "tradeID": 141,
                    "price": "0.20000000",
                    "base_volume": "0.0200000000000000",
                    "quote_volume": "0.10000000",
                    "trade_timestamp": 1582716769,
                    "type": "buy"
                }
            ]

Parameters :

Name Type Status Description
market_pair string Mandatory A pair such as LTC_BTC.
type/side string Recommended type/side string Recommended Query buy side or sell side only.

Error Response :

  • {"code":204,"msg":"No data found"}
  • {"code":500,"msg":"Some Error Occurred ! Please Try again!!"}