API Reference

Cancel By Label

Method Name

private/cancel_by_label

Cancel all open orders for a given subaccount and a given label. If instrument_name is provided, only orders for that instrument will be cancelled.
Required minimum session key permission level is admin

Parameters

label string required
Cancel all orders for this label
subaccount_id integer required
Subaccount ID
instrument_name string
Instrument name. If not provided, all orders for all instruments with the label will be cancelled. If provided, request counts as a regular matching request for ratelimit purposes.

Response

id string or integer required
result string required

enum ok

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}