`bullpen hyperliquid cancel-by-cloid`¶

Last updated: July 13, 2026

Cancel a resting order by client order ID (requires hyperliquid_trading feature)

Usage¶

bullpen hyperliquid cancel-by-cloid [OPTIONS] <COIN> <CLOID>

Live Help¶

Cancel a resting order by client order ID (requires hyperliquid_trading feature)

Usage: bullpen hyperliquid cancel-by-cloid [OPTIONS] <COIN> <CLOID>

Arguments:
  <COIN>
          Coin/market (e.g. "ETH", "BTC")

  <CLOID>
          Client order ID (cloid) to cancel

Options:
      --dex <DEX>
          HIP-3 perpetual DEX id (for example, `xyz` for TradeXYZ). If COIN is prefixed as `dex:symbol`, the prefix infers this value

      --no-multi-wallet-warning
          Suppress the table-mode warning shown when multiple EVM wallet accounts exist

      --output <OUTPUT>
          Output format for command results

          [possible values: table, json]

      --env <ENV>
          Target environment to connect to (overrides config.toml)

          [env: BULLPEN_ENV=]
          [possible values: staging, production]

      --subaccount <SUBACCOUNT>
          Target a Hyperliquid subaccount execution context. Without --subaccount or --vault, the command targets the active EVM master account. Scoped submits still sign with the active EVM master wallet. Mutually exclusive with --vault

      --config <CONFIG>
          Path to a custom config.toml file (overrides $BULLPEN_CONFIG and the default location).

          Explicit --config and BULLPEN_CONFIG paths fail closed: if the file is missing, the CLI exits validation instead of silently loading defaults. Credentials still resolve via BULLPEN_HOME, so set BULLPEN_HOME too when isolating a session.

      --vault <VAULT>
          Target a Hyperliquid vault execution context. Without --subaccount or --vault, the command targets the active EVM master account. Scoped submits still sign with the active EVM master wallet. Mutually exclusive with --subaccount

  -y, --yes
          Skip confirmation prompt

      --preview
          Show the planned cloid cancel without signing or submitting

      --read-only
          Enable read-only mode: blocks all mutating commands

      --non-interactive
          Suppress interactive prompts; does NOT imply --yes for money-moving commands

          [env: BULLPEN_NON_INTERACTIVE=]

  -h, --help
          Print help (see a summary with '-h')

EXAMPLES:
  # Review frontend orders before canceling by client order ID
  bullpen hyperliquid frontend-orders

  # Inspect one client order ID before deciding whether to cancel it
  bullpen hyperliquid order-status --cloid 0x1234567890abcdef1234567890abcdef

  # Preview a cloid cancel without signing or submitting
  bullpen hyperliquid cancel-by-cloid BTC 0x1234567890abcdef1234567890abcdef --preview

Example Commands¶

bullpen hyperliquid frontend-orders
bullpen hyperliquid order-status --cloid 0x1234567890abcdef1234567890abcdef
bullpen hyperliquid cancel-by-cloid BTC 0x1234567890abcdef1234567890abcdef --preview
bullpen hyperliquid cancel-by-cloid BTC 0x1234567890abcdef1234567890abcdef --preview --output json

JSON Output¶

Contract: JSON Output Contract.

Successful output is a single JSON document. The shape below is representative for this command family; commands may add fields without breaking the shared contract.

Schema version: 1 when a command emits schema_version; otherwise treat the current command shape as contract version 1.

Top-level Keys¶

key	type	nullable	notes
`schema_version`	integer	yes	Mutation preview/report schema version when emitted
`kind`	string	yes	`hyperliquid_mutation_preview` for preview JSON
`action`	string	no	Hyperliquid action represented by the preview or live report
`account`	string	no	Active Hyperliquid master account that signs live submits
`scope`	string	yes	Human-readable account, subaccount, or vault execution context
`scope_kind`	string	yes	Stable scope classification such as `primary`, `subaccount`, or `vault` when emitted
`coin`	string	yes	Market symbol when the command targets a single market
`perp_dex`	string	yes	HIP-3 DEX id when the command is DEX-scoped
`instrument_id`	string	yes	Stable DEX-qualified instrument id when available
`would_submit`	boolean	yes	False in preview output
`signature_requested`	boolean	yes	False in preview output
`exchange_request_submitted`	boolean	yes	False in preview output
`summary`	string	yes	Human-readable preview/result summary
`intent`	object	yes	Structured action intent echoed for previews and some live reports
`limit_px`	string/decimal	yes	Effective live order limit price when emitted; stop-market entries use a slippage-padded trigger price
`trigger_px`	string/decimal	yes	Trigger price for stop-entry or trigger-style commands
`trigger_kind`	string	yes	Trigger direction such as `entry-long` or `entry-short` for stop-entry
`submitted_count`	integer	yes	Live report count for submitted exchange actions; null/absent in previews
`status_count`	integer	yes	Live report count for exchange statuses returned

Example¶

Example JSON output

bullpen hyperliquid cancel-by-cloid BTC 0x1234567890abcdef1234567890abcdef --preview --output json

{
  "schema_version": 1,
  "kind": "hyperliquid_mutation_preview",
  "action": "cancel-by-cloid",
  "account": "0x1111111111111111111111111111111111111111",
  "scope": "primary 0x1111111111111111111111111111111111111111",
  "scope_kind": "primary",
  "coin": "BTC",
  "would_submit": false,
  "signature_requested": false,
  "exchange_request_submitted": false,
  "summary": "Preview only - no signature requested and no Hyperliquid exchange request submitted.",
  "intent": {
    "action": "cancel-by-cloid",
    "account": "0x1111111111111111111111111111111111111111",
    "coin": "BTC",
    "reduce_only": false,
    "builder_fee_bps": 0.0
  },
  "submitted_count": null,
  "status_count": null
}

Stability¶

Patch releases may add nullable or optional fields. Minor releases may add required fields or increment schema_version. Major releases may remove or rename fields.

bullpen hyperliquid cancel-by-cloid¶