Reference
CLI Reference
Complete command reference for openbroker.
| Category | Command | Description |
|---|---|---|
| Setup | setup, onboard | Interactive setup wizard (wallet + config + builder) |
| Setup | approve-builder | Approve builder fee (one-time) |
| Info | account | Balance, equity, margin, positions |
| Info | positions | Detailed positions with PnL and liquidation |
| Info | fills | Trade fill history with fees and realized PnL |
| Info | orders | Order history (filled, canceled, open, etc.) |
| Info | order-status | Check status of a specific order by ID |
| Info | fees | Fee tier, maker/taker rates, volume |
| Info | funding | Funding rates sorted by annualized rate |
| Info | funding-history | Historical funding rates for an asset |
| Info | candles | OHLCV candlestick data |
| Info | trades | Recent trades (tape) with buy/sell volume |
| Info | markets | Perp market data, prices, volume, OI |
| Info | all-markets | All markets (perps, HIP-3, spot) |
| Info | search | Search assets across all providers |
| Info | spot | Spot markets and token balances |
| Info | funding-scan | Cross-dex funding scanner (main + HIP-3) |
| Info | rate-limit | API rate limit usage and capacity |
| Trading | buy | Market buy (shortcut for market --side buy) |
| Trading | sell | Market sell (shortcut for market --side sell) |
| Trading | market | Market order with --side flag |
| Trading | limit | Limit order (GTC, IOC, or ALO) |
| Trading | trigger | Trigger order (TP/SL conditional) |
| Trading | tpsl | Set TP/SL on existing position |
| Trading | cancel | Cancel orders (by coin, ID, or all) |
| Advanced | twap | Native TWAP order (exchange-managed) |
| Advanced | twap-cancel | Cancel a running TWAP order |
| Advanced | twap-status | View TWAP order history and status |
| Advanced | scale | Grid of limit orders (linear/exp/flat) |
| Advanced | bracket | Entry + TP + SL in one command |
| Advanced | chase | Chase price with ALO orders |
| Auto | auto run <script> | Run a custom trading automation |
| Auto | auto examples | List bundled examples with config schemas |
| Auto | auto list | List available automation scripts |
| Auto | auto status | Show running automations |