Orderbook

private/cancel_by_label

Cancels a subaccount's open orders that carry the given client label, optionally scoped to a single instrument_name. When an instrument is supplied the call is acknowledged with the number of orders cancelled; without one it runs as a bulk fire-and-forget cancel and returns a -1 sentinel count. Requires any trade scope.

post/private/cancel_by_label

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/cancel_by_label
  • Auth: none declared

Request body

instrument_namestring nullable
labelstring required
subaccount_idinteger required

Response

Success

cancelled_ordersinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.