API HTX

HTX

HTX (formerly Huobi) is an international multi-language cryptocurrency exchange. The HTX API component provides an HTTP REST API to complement the existing Huobi WebSocket API.

APIs supported

• WebSocket API: connect to a websocket server and provides real-time market data updates, account changes and more. See the Huobi API documentation for WebSocket subscription methods.
• REST API: send HTTP requests to get market data, place orders, account data...

Properties

You can configure the following properties in the Huobi property (for WebSocket) or HTXOptions property (for REST API).

• ApiKey: you can request a new api key in your HTX account, just copy the value to this property. If the APIKey is set, the client will connect to the websocket private server. If it's empty, will connect to the WebSocket public server.
• ApiSecret: it's the secret value of the api.

Connection

The HTX component extends the Huobi WebSocket API client. When the client successfully connects to HTX servers, the event OnConnect is fired. If the ApiKey is not empty, the client will attempt to connect to the private websocket server, so only the private methods will be available. If the ApiKey is empty, the client will connect to the public websocket server and only the public methods will be available.

TsgcWebSocketClient oClient = new TsgcWebSocketClient();
TsgcWS_API_Huobi oHTX = new TsgcWS_API_Huobi();
oHTX.Client = oClient;
oHTX.Huobi.ApiKey = "your_api_key";
oHTX.Huobi.ApiSecret = "your_api_secret";
oClient.Active = true;
void OnConnect(TsgcWSConnection Connection)
{
  DoLog("#HTX Connected");
}

Events

The HTX client implements the following events to control the connection flow and get data sent from the WebSocket server:

• OnConnect: fired when the websocket client connects to the WebSocket Server.
• OnDisconnect: fired when the websocket client disconnects from the WebSocket Server.
• OnHuobiSubscribed: event called after a successful subscription.
• OnHuobiUnSubscribed: event called after a successful unsubscription.
• OnHuobiUpdate: every time there is an update in data (kline, market depth...) this event is called.
• OnHuobiError: if there is an error in the HTX API, this event will provide information about the error.

WebSocket API

The WebSocket API provides real-time market data updates. See the Huobi API documentation for the full list of WebSocket subscription methods including public channels (SubscribeKLine, SubscribeMarketDepth, SubscribeTradeDetail, etc.) and private channels (SubscribeOrderUpdates, SubscribeTradeClearing, SubscribeAccountChange).

REST API

The REST API provides Public and Private methods to request data from markets and private accounts. The REST API is accessed through the TsgcHTTP_API_HTX component.

Market Data (Public)

Method	Description
GetServerTime	Get the server time.
GetSymbols	Get the list of available trading symbols.
GetCurrencys	Get the list of supported currencies.
GetMarketTickers	Get tickers for all trading symbols.
GetMarketDetail	Get the 24-hour market detail for a symbol.
GetMarketDepth	Get the order book depth for a symbol. Supports configurable depth type and depth levels.
GetMarketTrade	Get the most recent trade for a symbol.
GetMarketHistoryTrade	Get the most recent trades history for a symbol.
GetMarketHistoryKline	Get candlestick/kline data. Supports multiple periods (1min, 5min, 15min, 30min, 60min, 4hour, 1day, 1mon, 1week, 1year).

Trading (Private)

Method	Description
PlaceOrder	Place a new order. Supports buy-market, sell-market, buy-limit, sell-limit and other order types.
CancelOrder	Cancel an existing order by order ID.
GetOrder	Get details of a specific order.
GetOpenOrders	Get the list of open orders for an account.
GetOrderHistory	Get the order history for a symbol.

Account (Private)

Method	Description
GetAccounts	Get the list of accounts.
GetAccountBalance	Get the balance of a specific account.
GetAccountAssetValuation	Get the total asset valuation for an account type (e.g. spot).

Find below an example of using the REST API.

TsgcHTTP_API_HTX oHTX = new TsgcHTTP_API_HTX();
oHTX.HTXOptions.ApiKey = "your_api_key";
oHTX.HTXOptions.ApiSecret = "your_api_secret";
// Get market tickers
oHTX.GetMarketTickers();
// Get kline data
oHTX.GetMarketHistoryKline("btcusdt", "1min", 150);
// Place an order
oHTX.PlaceOrder("12345678", "btcusdt", "buy-limit", "0.001", "50000");
// Get account balance
oHTX.GetAccountBalance("12345678");