> ## Documentation Index
> Fetch the complete documentation index at: https://v3.docs.derive.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel orders matching a 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.



## OpenAPI

````yaml /openapi.json post /private/cancel_by_label
openapi: 3.1.0
info:
  title: Derive v3 API
  version: 0.2.0
  description: JSON-RPC 2.0 methods, served over WebSocket and HTTP POST.
servers:
  - url: https://api.derive.xyz/v3
    description: Production (HTTP POST base)
  - url: https://testnet.api.derive.xyz/v3
    description: Testnet (HTTP POST base)
security: []
tags:
  - name: Subaccounts
    description: >-
      List, inspect, and label subaccounts, portfolios, positions, and
      collateral.
  - name: Session Keys
    description: Register, edit, and list delegated signing keys.
  - name: Account
    description: Wallet-level account information and settings.
  - name: Orderbook
    description: Place, replace, cancel, and query orders, trigger orders, and algos.
  - name: RFQ
    description: 'Request-for-quote: send RFQs, quote, and execute block trades.'
  - name: Vault Shareholders
    description: >-
      Deposit into and withdraw from vaults, and track shares, requests, and
      performance.
  - name: Vault Curators
    description: >-
      Create and operate curated vaults: settle deposit and withdrawal requests,
      and manage vault metadata.
  - name: History
    description: >-
      Per-account historical records: orders, trades, transfers, and
      settlements.
  - name: Market Maker Protection
    description: Configure, read, and reset market-maker protection.
  - name: Transfers & Withdrawals
    description: Move collateral between subaccounts, to other wallets, and on-chain.
  - name: System
    description: Rate limits and transaction lookups.
  - name: Market Data
    description: Instruments, currencies, tickers, and market-wide feeds.
  - name: Referrals
    description: Referral codes and program performance.
  - name: Other
    description: Uncategorized.
paths:
  /private/cancel_by_label:
    post:
      tags:
        - Orderbook
      summary: Cancel orders matching a label
      description: >-
        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.
      operationId: private_cancel_by_label
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelByLabelRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelByLabelResponse'
        default:
          description: JSON-RPC error (see Error Codes)
components:
  schemas:
    CancelByLabelRequest:
      type: object
      required:
        - label
        - subaccount_id
      properties:
        instrument_name:
          default: null
          type:
            - string
            - 'null'
        label:
          type: string
        subaccount_id:
          type: integer
          format: int64
    CancelByLabelResponse:
      type: object
      required:
        - cancelled_orders
      properties:
        cancelled_orders:
          type: integer
          format: int64

````

## Related topics

- [Orderbook Trading](/trading/order-types.md)
- [Rate Limits](/rate-limits.md)
- [Cancel a trigger order by id](/api-reference/orderbook/cancel-a-trigger-order-by-id.md)