`bullpen hyperliquid spot scale`¶

Last updated: July 13, 2026

Place or preview a Hyperliquid spot scale ladder

Usage¶

bullpen hyperliquid spot scale [OPTIONS] --pair <PAIR> --side <SIDE> --start <START> --end <END> --levels <LEVELS>

Live Help¶

Place or preview a Hyperliquid spot scale ladder

Usage: bullpen hyperliquid spot scale [OPTIONS] --pair <PAIR> --side <SIDE> --start <START> --end <END> --levels <LEVELS>

Options:
      --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]

      --pair <PAIR>
          Hyperliquid spot pair (for example, HYPE/USDC)

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

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

      --side <SIDE>
          Spot ladder side

          Possible values:
          - buy:  Buy the base token with the quote token
          - sell: Sell the base token for the quote token

      --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.

      --notional <NOTIONAL>
          Total quote-token notional to distribute across the ladder. Mutually exclusive with --base-size

      --base-size <BASE_SIZE>
          Total base-token size to distribute across the ladder. Mutually exclusive with --notional

      --start <START>
          First limit price in quote units

      --end <END>
          Final limit price in quote units

      --levels <LEVELS>
          Number of limit levels to place

      --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=]

      --skew <SKEW>
          Linear size skew from start to end. 1.0 is uniform; values below 1 taper down

          [default: 1]

      --tif <TIF>
          Time-in-force for every spot scale level

          Possible values:
          - gtc: Good-till-cancelled: rests on the book until explicitly cancelled
          - ioc: Immediate-or-cancel: fills what it can immediately and cancels the rest
          - alo: Add-liquidity-only: post-only, rejects if it would cross the spread

          [default: gtc]

      --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

      --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 spot ladder without signing or submitting

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

EXAMPLES:
  # Preview a three-level HYPE/USDC spot buy ladder without signing or submitting
  bullpen hyperliquid spot scale --pair HYPE/USDC --side buy --notional 300 --start 25 --end 23 --levels 3 --preview

  # Preview a spot sell ladder sized in base-token units
  bullpen hyperliquid spot scale --pair HYPE/USDC --side sell --base-size 1.5 --start 30 --end 32 --levels 3 --preview

  # Export the spot scale preview as JSON
  bullpen hyperliquid spot scale --pair HYPE/USDC --side buy --notional 300 --start 25 --end 23 --levels 3 --preview --output json

SIZING:
  Provide exactly one sizing mode. --notional is total quote-token notional
  split across levels; --base-size is total base-token size split across levels.

SAFETY:
  Preview resolves spotMetaAndAssetCtxs and shows official spot asset-id ladder
  levels without signing or submitting. Live submit posts one Hyperliquid spot
  batch order with no builder attribution, no leverage, and reduce-only=false
  for every level. Use spot orders/order-status/cancel/cancel-all for cleanup.

Example Commands¶

bullpen hyperliquid spot scale --pair HYPE/USDC --side buy --notional 300 --start 25 --end 23 --levels 3 --preview
bullpen hyperliquid spot scale --pair HYPE/USDC --side sell --base-size 1.5 --start 30 --end 32 --levels 3 --preview
bullpen hyperliquid spot scale --pair HYPE/USDC --side buy --notional 300 --start 25 --end 23 --levels 3 --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	Spot scale preview/report schema version when emitted
`action`	string	no	Always `spot-scale` for this command
`account`	string	no	Active Hyperliquid master account that signs live submits
`spot_pair`	string	no	Spot pair such as `HYPE/USDC`
`spot_asset_id`	integer	no	Canonical Hyperliquid spot asset id
`spot_side`	string	no	`buy` or `sell`
`success`	boolean	no	True when preview construction or live submission succeeded
`result_status`	string	yes	`preview` for preview output; live status when available
`requested_notional_usd`	string/decimal	yes	Total planned notional across scale levels
`base_size`	string/decimal	yes	Total planned base size across scale levels
`tif`	string	yes	Time-in-force used for each scale level
`reduce_only`	boolean	yes	Always false for Hyperliquid spot scale
`scale_orders`	array	no	Planned or submitted spot scale levels with price, size, notional, side, tif, and optional submit status
`order_statuses`	array	no	Live per-level exchange statuses; empty in preview output

Example¶

Example JSON output

bullpen hyperliquid spot scale --pair HYPE/USDC --side buy --notional 300 --start 25 --end 23 --levels 3 --preview --output json

{
  "action": "spot-scale",
  "account": "primary 0x1111111111111111111111111111111111111111",
  "coin": "HYPE/USDC",
  "spot_pair": "HYPE/USDC",
  "spot_asset_id": 10001,
  "spot_side": "buy",
  "success": true,
  "result_status": "preview",
  "summary": "Preview only - no signature requested and no Hyperliquid exchange request submitted. Planned 3 Hyperliquid spot scale level(s).",
  "requested_notional_usd": "300",
  "base_size": "12.533333",
  "tif": "gtc",
  "reduce_only": false,
  "scale_orders": [
    {
      "coin": "HYPE/USDC",
      "asset_id": 10001,
      "side": "buy",
      "limit_px": "25",
      "base_size": "4",
      "notional_usd": "100",
      "tif": "gtc",
      "client_order_id": "0x11111111111111111111111111111111"
    },
    {
      "coin": "HYPE/USDC",
      "asset_id": 10001,
      "side": "buy",
      "limit_px": "24",
      "base_size": "4.166667",
      "notional_usd": "100",
      "tif": "gtc",
      "client_order_id": "0x22222222222222222222222222222222"
    },
    {
      "coin": "HYPE/USDC",
      "asset_id": 10001,
      "side": "buy",
      "limit_px": "23",
      "base_size": "4.366667",
      "notional_usd": "100",
      "tif": "gtc",
      "client_order_id": "0x33333333333333333333333333333333"
    }
  ],
  "order_statuses": []
}

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 spot scale¶