API Reference

Cancel By Nonce

Method Name

private/cancel_by_nonce

Cancel a single order by nonce. Uses up that nonce if the order does not exist, so any future orders with that nonce will fail
Required minimum session key permission level is admin

Parameters

instrument_name string required
Instrument name
nonce integer required
Cancel an order with this nonce
subaccount_id integer required
Subaccount ID
wallet string required
Wallet address

Response

id string or integer required
result object required
result.cancelled_orders integer required
Number of cancelled orders

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}