HomeDocumentationAPI Reference
Log In
API Reference

Cancel By Instrument

Method Name

private/cancel_by_instrument

Cancel all orders for this instrument.
Required minimum session key permission level is admin

Parameters

instrument_namestringrequired
Cancel all orders for this instrument
subaccount_idintegerrequired
Subaccount ID

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}