bullpen polymarket clob books¶
Last updated: July 13, 2026
Get order books for multiple token IDs (batch)
Usage¶
Live Help¶
Get order books for multiple token IDs (batch)
Usage: bullpen polymarket clob books [OPTIONS] <TOKEN_IDS>
Arguments:
<TOKEN_IDS>
Comma-separated token IDs (decimal or 0x hex)
Options:
--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]
--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 order book depth for several CLOB token IDs
bullpen polymarket clob books 1234567890,2345678901
# Export batch order books as JSON
bullpen polymarket clob books 1234567890,2345678901 --output json
Example Commands¶
bullpen polymarket clob books 1234567890,2345678901
bullpen polymarket clob books 1234567890,2345678901 --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 |
|---|---|---|---|
entries |
array | no | Batch order-book rows returned by CLOB; rows may be omitted for token IDs with no data |
entries[].token_id |
string | no | CLOB token ID requested by the batch lookup |
entries[].timestamp |
string | yes | Upstream order-book timestamp when present |
entries[].bids |
array | no | Bid levels with price and size strings |
entries[].asks |
array | no | Ask levels with price and size strings |
Example¶
{
"entries": [
{
"token_id": "1234567890",
"timestamp": "1779920575394",
"bids": [
{ "price": "0.51", "size": "100" }
],
"asks": [
{ "price": "0.53", "size": "125" }
]
}
]
}
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.