bullpen polymarket orderbook¶
Last updated: July 13, 2026
Show the live orderbook (bids and asks) for a market outcome.
Usage¶
Live Help¶
Show the live orderbook (bids and asks) for a market outcome.
Binary markets accept the same outcome aliases as trading commands: Y/N, True/False, and 1/0. Unknown outcomes return a typed OUTCOME_NOT_FOUND JSON error in `--output json` mode.
Usage: bullpen polymarket orderbook [OPTIONS] <MARKET>
Arguments:
<MARKET>
Market slug, numeric Gamma ID, CLOB token ID, or condition ID
Options:
--outcome <OUTCOME>
Outcome name exactly as shown by market data; Y/N, True/False, and 1/0 are accepted only when the market exposes Yes/No labels
--output <OUTPUT>
Output format for command results
[possible values: table, json]
--depth <DEPTH>
Number of price levels to display on each side
[default: 10]
--env <ENV>
Target environment to connect to (overrides config.toml)
[env: BULLPEN_ENV=]
[possible values: staging, production]
--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.
--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:
# Show the top orderbook levels for one market outcome
bullpen polymarket orderbook will-ronaldo-cry-at-the-world-cup-20260604013616610 --outcome Yes --depth 10
# Export the same orderbook levels as JSON
bullpen polymarket orderbook will-ronaldo-cry-at-the-world-cup-20260604013616610 --outcome Yes --depth 10 --output json
Example Commands¶
bullpen polymarket orderbook will-ronaldo-cry-at-the-world-cup-20260604013616610 --outcome Yes --depth 10
bullpen polymarket orderbook will-ronaldo-cry-at-the-world-cup-20260604013616610 --outcome Yes --depth 10 --output json
bullpen polymarket orderbook will-ronaldo-cry-at-the-world-cup-20260604013616610 --outcome No --depth 10 --output json
JSON Output¶
Contract: JSON Output Contract.
This command supports --output json, but this generated reference page intentionally does not include a synthetic success schema or example.
Use the live command in your target environment to inspect command-specific success fields. Error output follows the shared JSON output contract linked above.
Schema version: 1 when a command emits schema_version; otherwise treat the current command shape as contract version 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.