Cancel Trigger Order

Method Name

`private/cancel_trigger_order`

Cancels a trigger order.
Required minimum session key permission level is admin

Parameters


order_id string required
subaccount_id integer required

Response


id string or integer required
result object required
result. amount string required Order amount in units of the base
result. average_price string required Average fill price
result. cancel_reason string required If cancelled, reason behind order cancellation enum `user_request` `mmp_trigger` `insufficient_margin` `signed_max_fee_too_low` `cancel_on_disconnect` `ioc_or_market_partial_fill` `session_key_deregistered` `subaccount_withdrawn` `compliance` `trigger_failed` `validation_failed` `algo_completed`
result. creation_timestamp integer required Creation timestamp (in ms since Unix epoch)
result. direction string required Order direction enum `buy` `sell`
result. filled_amount string required Total filled amount for the order
result. instrument_name string required Instrument name
result. is_transfer boolean required Whether the order was generated through `private/transfer_position`
result. label string required Optional user-defined label for the order
result. last_update_timestamp integer required Last update timestamp (in ms since Unix epoch)
result. limit_price string required Limit price in quote currency
result. max_fee string required Max fee PER contract, denominated in USDC.Max fee must be > 2 x max(taker_fee, maker_fee) x spot_price + extra_fee / amount.If the order crosses the book, it must be >= 2 x max(taker_fee, maker_fee) x spot_price + base_fee / fill_amount + extra_fee / amount.Note, in this calculation, regardless of the account taker / maker fees, the standard taker / maker fees are used.
result. mmp boolean required Whether the order is tagged for market maker protections
result. nonce integer required Unique nonce defined as (UTC_timestamp in ms)(random_number_up_to_3_digits) (e.g. 1695836058725001, where 001 is the random number)
result. order_fee string required Order fee paid so far
result. order_id string required Order ID
result. order_status string required Order status enum `open` `filled` `cancelled` `expired` `untriggered` `algo_active`
result. order_type string required Order type enum `limit` `market`
result. quote_id string or null required Quote ID if the trade was executed via RFQ
result. signature string required Ethereum signature of the order
result. signature_expiry_sec integer required Signature expiry timestamp
result. signer string required Owner wallet address or registered session key that signed order
result. subaccount_id integer required Subaccount ID
result. time_in_force string required Time in force enum `gtc` `post_only` `fok` `ioc`
result. algo_duration_sec integer or null Total execution window in seconds
result. algo_num_slices integer or null Number of child executions
result. algo_slices_completed integer or null Number of slices executed so far
result. algo_type string or null Algo order type (twap or vwap) enum `twap`
result. extra_fee string or null (Optional) Extra fee in USDC added to the total final fee paid by user (must be between 0.000001 and 1,000 USDC).
result. replaced_order_id string or null If replaced, ID of the order that was replaced
result. signed_limit_price string or null The original limit price that the user signed. Only set when the order was adjusted (i.e., for post-only orders with reject_post_only=false that would have crossed). Used for on-chain submission.
result. trigger_price string or null (Required for trigger orders) Index or Market price to trigger order at
result. trigger_price_type string or null (Required for trigger orders) Trigger with Index or Mark Price enum `mark` `index`
result. trigger_reject_message string or null (Required for trigger orders) Error message if error occured during trigger
result. trigger_type string or null (Required for trigger orders) Stop-loss or Take-profit. enum `stoploss` `takeprofit`

Example

{request_example_shell}

{request_example_javascript}

{request_example_python}

The above command returns JSON structured like this:

{response_example_json}