bullpen hyperliquid candles¶
Last updated: July 13, 2026
Show OHLCV candle data for a market
Usage¶
Live Help¶
Show OHLCV candle data for a market
Usage: bullpen hyperliquid candles [OPTIONS] <COIN>
Arguments:
<COIN>
Market/coin name (e.g. "ETH", "BTC")
Options:
--dex <DEX>
Optional HIP-3 perp DEX context
--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]
--interval <INTERVAL>
Candle interval
[default: 1h]
[possible values: 1m, 5m, 15m, 1h, 4h, 1d]
--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.
--start <START>
Start of the candle window in Unix milliseconds. Defaults to roughly the last 200 candles
--end <END>
End of the candle window in Unix milliseconds. Defaults to the current time
--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 hourly candles for BTC
bullpen hyperliquid candles BTC --interval 1h
# Show hourly BTC candles in an explicit HIP-3 DEX context
bullpen hyperliquid candles BTC --dex perp --interval 1h
# Export hourly BTC candles as JSON
bullpen hyperliquid candles BTC --interval 1h --output json
Example Commands¶
bullpen hyperliquid candles BTC --interval 1h
bullpen hyperliquid candles BTC --dex perp --interval 1h
bullpen hyperliquid candles BTC --interval 1h --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.