bullpen hyperliquid watch orderbook

Last updated: May 29, 2026

Watch live L2 orderbook updates for a market

Usage

bullpen hyperliquid watch orderbook [OPTIONS] <COIN>

Live Help

Watch live L2 orderbook updates for a market

Usage: bullpen hyperliquid watch orderbook [OPTIONS] <COIN>

Arguments:
  <COIN>
          Market/coin name (e.g. "ETH", "BTC")

Options:
      --n-sig-figs <N_SIG_FIGS>
          Optional Hyperliquid orderbook significant-figure aggregation (2-5)

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

      --mantissa <MANTISSA>
          Optional Hyperliquid orderbook mantissa aggregation. Allowed values: 2 or 5

      --allow-duplicate
          Allow a duplicate listener for this stream/scope

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

      --updates <UPDATES>
          Exit after printing this many payload messages

      --timeout <DURATION>
          Exit if this duration elapses before the requested updates arrive (e.g. 2s, 500ms)

      --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:
  bullpen hyperliquid watch orderbook --help
      Show options for this command without signing, submitting, or changing state.

Example Commands

bullpen hyperliquid watch orderbook [OPTIONS] <COIN>
bullpen hyperliquid watch orderbook --help
bullpen hyperliquid watch orderbook BTC --output json

JSON Output

Contract: JSON Output Contract.

Streaming output emits one JSON document per event line. Each event follows the shared contract, including SIGPIPE-safe pipe behavior.

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
channel	string	no	Hyperliquid websocket channel name
data	object/array	no	Raw channel payload; shape varies by stream

Example

bullpen hyperliquid watch orderbook BTC --output json

{
  "channel": "l2Book",
  "data": {
    "coin": "BTC",
    "levels": [
      [{ "px": "109499.0", "sz": "1.2", "n": 2 }],
      [{ "px": "109500.0", "sz": "0.8", "n": 1 }]
    ],
    "time": 1779920575394
  }
}

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.