`bullpen hyperliquid watch bbo`¶

Last updated: July 13, 2026

Watch the best bid/offer for a market

Usage¶

bullpen hyperliquid watch bbo [OPTIONS] <COIN>

Live Help¶

Watch the best bid/offer for a market

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

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

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

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

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

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

      --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:
  # Print one best-bid-offer update for BTC and exit
  bullpen hyperliquid watch bbo BTC --updates 1 --timeout 5s

  # Export one bounded best-bid-offer update as JSON
  bullpen hyperliquid watch bbo BTC --updates 1 --timeout 5s --output json

Example Commands¶

bullpen hyperliquid watch bbo BTC --updates 1 --timeout 5s
bullpen hyperliquid watch bbo BTC --updates 1 --timeout 5s --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.

Hyperliquid watch JSON preserves the shared channel + data envelope. After a successful reconnect, the first following data event may include optional top-level metadata.reconnect_count and metadata.failed_attempt_count; no standalone JSON reconnect event is emitted.

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
`metadata.reconnect_count`	integer	yes	Successful reconnect count, present only on the first data event after a reconnect
`metadata.failed_attempt_count`	integer	yes	Failed websocket reconnect attempts before that successful reconnect

Example¶

bullpen hyperliquid watch bbo BTC --updates 1 --timeout 5s --output json

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

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 watch bbo¶