HTX Has Supported Stop Limit Order in API

Dear API users,

HTX is currently supporting stop limit order on official web page. Since the effective day of this notification, HTX will support this order type in API too.

Effective Date: August 29, 2019 (GMT+8)
All the changes will be updated on https://huobiapi.github.io/docs/spot/v1/en/

HTX
September 2, 2019

The following are change details:
When API user places a stop limit order by defining order type as “buy-stop-limit” or “sell-stop-limit”, “stop-price” & “operator” should be also defined. The valid enumerated value inside “operator” is “gte” or “lte”. GTE means if the market last price is greater than or equal to the defined stop price, the stop limit order will be triggered. LTE refers to “less than or equal”. Kindly note that, if the defined stop price and operator fall the stop limit order into immediate triggering, the order will be rejected.

At this point of time, HTX is only going to support stop limit order type, rather than stop market order type.

When a stop limit order was placed, its status should be firstly updated as “created”. But after it’s triggered by market price later, the order enters into order book and its status changes to “submitted”. Kindly note that, while a stop limit order is still under “created” status, HTX Websocket API will not push order update message down to the user, but the order can be queried out. While the order status changes to “submitted”, Websocket order update should be pushed down.

Following APIs are impacted by the launch of stop limit order –

1) Existing REST endpoint for order submission - POST /v1/order/orders/place
Added new request fields “stop-price” & “operator”;
Added new enumerated value in existing request field “type”;

2) Existing REST endpoint for open order query - GET /v1/order/openOrders
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Added new enumerated value in existing response field “state”;

3) Existing REST endpoint for specific order (by order ID) query - GET /v1/order/orders/{order-id}
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Added new enumerated value in existing response field “state”;

4) Existing REST endpoint for specific order (by client order ID) query - GET /v1/order/orders/getClientOrder
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Added new enumerated value in existing response field “state”;

5) Existing REST endpoint for historical query - GET /v1/order/orders
Added new enumerated value in existing request field “types”;
Added new enumerated value in existing request field “states”;
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Added new enumerated value in existing response field “state”;

6) Existing REST endpoint for historical order (within 48 hours) query - GET /v1/order/history
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Note: If a stop limit order being cancelled before it being triggered, it cannot be queried out from this endpoint.

7) Existing REST endpoint for querying historical trades of a specific order - GET /v1/order/orders/{order-id}/matchresults
Added new enumerated value in existing response field “type”;

8) Existing REST endpoint for querying historical trades - GET /v1/order/matchresults
Added new enumerated value in existing request field “type”;
Added new enumerated value in existing response field “type”;

9) Existing Websocket order updates subscription - orders.$symbol
Added new enumerated value in existing response field “order-type”;
Note: If a stop limit order being created but not yet triggered, there will be no update from the subscription;

10) Existing Websocket order updates subscription (new) - orders.$symbol.update
Added new enumerated value in existing response field “order-type”;
Note: If a stop limit order being created but not yet triggered, there will be no update from the subscription;

11) Existing Websocket order list request – order.list
Added new enumerated value in existing request field “types”;
Added new enumerated value in existing request field “states”;
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Added new enumerated value in existing response field “state”;

12) Existing Websocket order details request – order.detail
Added new response fields “stop-price” & “operator”;
Added new enumerated value in existing response field “type”;
Added new enumerated value in existing response field “state”.