Info Commands
Account Info
View your balance, equity, margin, positions, and open orders. Automatically detects your account mode (standard, unified, or portfolio margin).
openbroker account # Balance, equity, margin, positions
openbroker account --orders # Also show open orders
openbroker account --json # JSON output for scripting
openbroker account --address 0xabc... # Look up another account| Flag | Description | Default |
|---|---|---|
| --orders | Include open orders in the output | — |
| --address | Look up another account by wallet address (0x...) | — |
| --json | Output as JSON for scripting or piping | — |
Positions
Detailed position view with entry/mark prices, PnL, leverage, liquidation distance, and margin used.
openbroker positions # All open positions
openbroker positions --coin HYPE # Single position detail
openbroker positions --json # JSON with mark prices and liquidation distances
openbroker positions --address 0xabc... # View another account's positions| Flag | Description | Default |
|---|---|---|
| --coin | Filter to a single asset | — |
| --address | Look up another account by wallet address (0x...) | — |
| --json | Output as JSON | — |
Trade Fills
View your trade executions with prices, fees, and realized PnL.
openbroker fills # Recent fills
openbroker fills --coin ETH # ETH fills only
openbroker fills --coin BTC --side buy --top 50
openbroker fills --address 0xabc... # Another account's fills
openbroker fills --json # JSON output| Flag | Description | Default |
|---|---|---|
| --coin | Filter by coin symbol | — |
| --side | Filter by side: buy or sell | — |
| --top | Number of recent fills to show | 20 |
| --address | Look up another account by wallet address (0x...) | — |
| --json | Output as JSON | — |
Order History
View all historical orders including filled, canceled, and rejected. Use --open to show only currently open orders.
openbroker orders # Recent orders
openbroker orders --open # Currently open orders only
openbroker orders --open --coin ETH # Open orders for a specific coin
openbroker orders --coin ETH --status filled
openbroker orders --top 50
openbroker orders --address 0xabc... --open # Another account's open orders
openbroker orders --json # JSON output| Flag | Description | Default |
|---|---|---|
| --coin | Filter by coin symbol | — |
| --status | Filter by status (filled, canceled, open, triggered, etc.) | — |
| --open | Show only currently open orders (uses dedicated endpoint) | — |
| --top | Number of recent orders to show | 20 |
| --address | Look up another account by wallet address (0x...) | — |
| --json | Output as JSON | — |
Order Status
Look up the status of a specific order by order ID or client order ID.
openbroker order-status --oid 123456789 # By order ID
openbroker order-status --oid 0x1234... # By client order ID
openbroker order-status --oid 123456789 --address 0xabc... # On another account
openbroker order-status --oid 123456789 --json # JSON output| Flag | Description | Default |
|---|---|---|
| --oid | Order ID (number) or client order ID (hex string) | required |
| --address | Look up order on another account by wallet address (0x...) | — |
| --json | Output as JSON | — |
Fee Schedule
View your fee tier, maker/taker rates, referral and staking discounts, and recent daily trading volumes.
openbroker fees # Your fee schedule
openbroker fees --address 0xabc... # Another account's fees
openbroker fees --json # JSON output| Flag | Description | Default |
|---|---|---|
| --address | Look up another account by wallet address (0x...) | — |
| --json | Output as JSON | — |
Funding Rates
openbroker funding # Top 20 by annualized rate
openbroker funding --top 50 # Top 50
openbroker funding --coin ETH # Single asset
openbroker funding --sort oi # Sort by open interest
openbroker funding --include-hip3 # Include HIP-3 dex assets
openbroker funding --coin xyz:CL # HIP-3 asset funding
openbroker funding --json # JSON output| Flag | Description | Default |
|---|---|---|
| --top | Number of results to show | 20 |
| --coin | Filter to a single asset (supports dex:COIN for HIP-3) | — |
| --sort | Sort by: annualized, hourly, or oi | annualized |
| --all | Show all assets including low OI | — |
| --include-hip3 | Include HIP-3 dex assets in the output | — |
| --json | Output as JSON | — |
Funding History
View historical funding rate data for an asset over time.
openbroker funding-history --coin ETH # Last 24h
openbroker funding-history --coin BTC --hours 168 # Last 7 days
openbroker funding-history --coin xyz:CL # HIP-3 asset
openbroker funding-history --coin ETH --json # JSON: coin, assetId, history| Flag | Description | Default |
|---|---|---|
| --coin | Asset symbol | required |
| --hours | Hours of history to fetch | 24 |
| --json | Output as JSON (includes assetId) | — |
Candle Data (OHLCV)
View candlestick chart data for any asset with configurable intervals.
openbroker candles --coin ETH # 24 hourly candles
openbroker candles --coin BTC --interval 4h --bars 48 # 48 four-hour bars
openbroker candles --coin SOL --interval 1d --bars 30 # 30 daily bars
openbroker candles --coin ETH --json # JSON: coin, assetId, interval, candles| Flag | Description | Default |
|---|---|---|
| --coin | Asset symbol | required |
| --interval | Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w, etc. | 1h |
| --bars | Number of bars to fetch | 24 |
| --json | Output as JSON (includes assetId) | — |
Recent Trades (Tape)
View recent trades for an asset with buy/sell volume breakdown.
openbroker trades --coin ETH # Last 30 trades
openbroker trades --coin BTC --top 50 # Last 50 trades
openbroker trades --coin ETH --json # JSON: coin, assetId, trades| Flag | Description | Default |
|---|---|---|
| --coin | Asset symbol | required |
| --top | Number of recent trades | 30 |
| --json | Output as JSON (includes assetId) | — |
Markets
Market data for perpetuals. Pass --coin for a detailed single-asset view with oracle price, min size, and more.
openbroker markets # Top 30 perps by volume
openbroker markets --coin ETH # Detailed view for ETH
openbroker markets --sort change --top 10 # Top movers
openbroker markets --include-hip3 # Include HIP-3 markets
openbroker markets --json # JSON output| Flag | Description | Default |
|---|---|---|
| --coin | Detailed view for a single asset | — |
| --top | Number of results | 30 |
| --sort | Sort by: volume, oi, or change | volume |
| --include-hip3 | Include HIP-3 markets in the output | — |
| --json | Output as JSON (includes assetId per market) | — |
All Markets
Browse all available markets across main perps, HIP-3 perps, spot, and HIP-4 outcome markets — grouped by type.
openbroker all-markets # Everything
openbroker all-markets --type perp # Main perps only
openbroker all-markets --type hip3 # HIP-3 perps only
openbroker all-markets --type spot # Spot only
openbroker all-markets --type outcome # HIP-4 prediction markets only
openbroker all-markets --top 20 # Top 20 by volume
openbroker all-markets --json # JSON (includes assetId per market)| Flag | Description | Default |
|---|---|---|
| --type | Filter: perp, spot, hip3, outcome, or all | all |
| --top | Limit to top N by volume | — |
| --json | Output as JSON (includes assetId) | — |
| --verbose | Show detailed output | — |
Search Markets
Search for assets by name across all providers (perps, HIP-3, spot, HIP-4 outcomes). Shows funding comparison when an asset is listed on multiple venues.
openbroker search --query GOLD # Find all GOLD markets
openbroker search --query ETH --type perp # ETH perps only
openbroker search --query PURR --type spot # PURR spot only
openbroker search --query BTC --type outcome # HIP-4 outcomes only
openbroker search HYPE --json # JSON with assetId per result| Flag | Description | Default |
|---|---|---|
| --query | Search term (matches coin name). Also accepts a positional arg. | required |
| --type | Filter: perp, spot, hip3, outcome, or all | all |
| --json | Output as JSON (includes assetId per market) | — |
| --verbose | Show detailed output | — |
Spot
openbroker spot # All spot markets
openbroker spot --balances # Your spot token balances
openbroker spot --balances --address 0xabc... # Another account's spot balances
openbroker spot --coin PURR # Filter by coin
openbroker spot --top 20 # Top 20 by volume
openbroker spot --json # JSON (includes assetId, base, quote)| Flag | Description | Default |
|---|---|---|
| --balances | Show your spot token balances instead of markets | — |
| --address | Look up another account's spot balances (with --balances) | — |
| --coin | Filter by coin symbol | — |
| --top | Limit to top N by volume | — |
| --json | Output as JSON (markets include assetId, base, quote) | — |
| --verbose | Show token metadata | — |
Outcomes
Search and inspect HIP-4 prediction markets. Outcome markets are YES/NO tokens with a spot-like order book. Recurring price outcomes include their specification in description, for example class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d.
Outcome sides use Hyperliquid's encoded coin format: #<encoding>, where encoding = 10 * outcomeId + side. Side 0 is usually YES and side 1 is usually NO.
openbroker outcomes --query BTC
openbroker outcomes --outcome 5846
openbroker outcomes --outcome 5846 --side yes --json
openbroker outcomes --balances| Flag | Description | Default |
|---|---|---|
| --query | Search market name, description, underlying, expiry, or target price | — |
| --outcome | Outcome id, #encoding, or +encoding | — |
| --side | Outcome side for plain ids: yes, no, 0, or 1 | yes |
| --balances | Show outcome token balances instead of markets | — |
| --top | Limit to top N by volume | — |
| --json | Output as JSON with side encodings and asset ids | — |
| --verbose | Show raw descriptions and question metadata | — |
Funding Rate Scanner
Scan funding rates across all dexes (main perps + HIP-3) and find arbitrage opportunities. Identifies opposing funding pairs for delta-neutral strategies.
openbroker funding-scan # Scan all dexes, >25% threshold
openbroker funding-scan --threshold 50 --pairs # Show opposing funding pairs
openbroker funding-scan --hip3-only --top 20 # HIP-3 only
openbroker funding-scan --watch --interval 120 # Re-scan every 2 minutes
openbroker funding-scan --json # JSON output for piping| Flag | Description | Default |
|---|---|---|
| --threshold | Min annualized funding rate % to show | 25 |
| --main-only | Only scan main perps | — |
| --hip3-only | Only scan HIP-3 perps | — |
| --top | Number of results to show | 30 |
| --pairs | Show opposing funding pairs for delta-neutral strategies | — |
| --json | Output as JSON for piping to alerting systems | — |
| --watch | Re-scan periodically | — |
| --interval | Watch interval in seconds | 60 |
Rate Limit
Check your API rate limit usage and capacity. Shows a progress bar for usage percentage.
openbroker rate-limit
openbroker rate-limit --json| Flag | Description | Default |
|---|---|---|
| --json | Output as JSON | — |
Asset IDs
Every info command that returns market data includes an assetId field in its --json output — the canonical Hyperliquid asset index. Prefer it over coin names when persisting references, because the same ticker can exist on multiple providers (e.g. HYPE perp, hyna:HYPE HIP-3, and HYPE/USDC spot all coexist).
| Scope | Formula | Example |
|---|---|---|
| Main perps | universe index | HYPE → 159 |
| HIP-3 perps | 100000 + dexIdx * 10000 + assetIdx | hyna:HYPE → 140002 |
| Spot | 10000 + pair.index | HYPE/USDC → 10107 |
| HIP-4 outcomes | 100000000 + (10 * outcomeId + side) | 5846 YES → 100058460 |
openbroker search HYPE --json | jq '.[] | {coin, assetId, type, provider}'Trading commands still take --coin <name> for perps/spot (including HIP-3 dex:COIN) — assetId is for queries, comparisons, and agent state, not order placement. HIP-4 outcome trading commands take --outcome <id|#encoding|+encoding> plus --outcome-side yes|no when using a plain id.