HomeDocumentationAPI Reference
Log In
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_namestringrequired
Instrument name
nonceintegerrequired
Cancel an order with this nonce
subaccount_idintegerrequired
Subaccount ID
walletstringrequired
Wallet address

Response

idstring or integerrequired
resultobjectrequired
result.cancelled_ordersintegerrequired
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}