Cancel or Modify Orders

Cancel Order

Request class: TigerHttpRequest(MethodName.CANCEL_ORDER)

Description

Cancel a placed order. Cancellation is asynchronous. A successful response contains only the order ID in data and confirms that the request was accepted; it does not mean the order has been canceled. Query the order afterward and check both status and cancelStatus. Use them together to determine the final result.

After submitting an order using TradeOrderRequest, the submitted order will enter various states depending on different circumstances. Orders that have already been filled or rejected by the system cannot be canceled. Only orders in submitted or partially filled status can be canceled. Please refer to the description of the TigerHttpRequest(MethodName.ORDERS) method to understand the possible order states.

For batch orders, you can use TigerHttpRequest(MethodName.ACTIVE_ORDERS) to get the list of pending orders and cancel them one by one. For orders that have already been requested for cancellation, do not repeat the request. After executing the cancellation command, wait for a period of time and then check the pending orders again.

Parameters

Parameter	Type	Required	Description
account	string	Yes	User authorized account: DU000001
id	long	Yes	Order ID returned when placing order
secret_key	string	No	Trader secret key, for institutional users only

Response

Name	Type	Description
id	long	Unique order ID, can be used to query/modify/cancel orders

Example

TigerHttpClient client = TigerHttpClient.getInstance().clientConfig(
      ClientConfig.DEFAULT_CONFIG);
TigerHttpRequest request = new TigerHttpRequest(MethodName.CANCEL_ORDER);

String bizContent = TradeParamBuilder.instance()
    .account("DU000001")
    .id(100000000000000001L)
    .buildJson();

request.setBizContent(bizContent);
TigerHttpResponse response = client.execute(request);
JSONObject data = JSON.parseObject(response.getData());
Long id = data.getLong("id");

Example Response

{
  "code": 0,
  "message": null,
  "timestamp": 1525938835697,
  "data": {
      "id":100000000000000001
  }
}

Rate Limit

The base rate limit is 120 requests/min.

Modify Order

Request class: TigerHttpRequest(MethodName.MODIFY_ORDER)

Description

Modification rules depend on the account and original order type:

Global accounts: There is no universal rule that every request must explicitly contain at least one changed field or that order_type can never be supplied. Supported fields and omission behavior depend on the original order type. Supply only fields supported for that order.
Prime/Paper accounts: The original order type determines how the modification is handled; order_type cannot convert the order to another type. Orders such as LMT, STP, STP_LMT, and TRAIL require an effective quantity, price, or trailing parameter appropriate to the original order type. See the table below.

Zero and omission are handled by account path:

Account path	`total_quantity=0`	Applicable price field is `0`	`order_type`	Omitted `time_in_force`
Global	Retains the original quantity when the resulting request has `order_type=LMT`	Retains the original limit price when the resulting request has `order_type=LMT`	An explicit value is retained; omission copies the original order type	Completed as `DAY`
Prime/Paper	Not sent as a new quantity	LMT/STP/STP_LMT/TRAIL prices are not sent as new values; multi-leg orders may use negative prices	The service queries and enforces the original order type	Completed as `DAY`

A Prime/Paper standard-order request must contain at least one quantity, price, or trailing change effective for the original order type. An Iceberg request may change only display sizes, check intervals, or effective times in algo_params; see the rules below.