Method Name
private/cancel
private/cancelCancel a single order.
Other private/cancel_* routes are available through both REST and WebSocket.
Required minimum session key permission level is admin
Parameters
| instrument_name
string
required
|
| 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 |
| 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 in units of the quote currency |
| result.mmp
boolean
required
Whether the order is tagged for market maker protections |
| result.nonce
integer
required
Unique nonce defined as |
| result.order_fee
string
required
Total 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 |
| 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.replaced_order_id
string or null
If replaced, ID of the order that was replaced |
| 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}