Open-broker

---

name: openbroker description: Hyperliquid trading plugin with background position monitoring and custom automations. Execute market orders, limit orders, manage positions, view funding rates, run trading strategies, and write event-driven automation scripts with automatic alerts for PnL changes and liquidation risk. license: MIT compatibility: Requires Node.js 22+, network access to api.hyperliquid.xyz homepage: https://www.npmjs.com/package/openbroker-plugin metadata: {"author": "monemetrics", "version": "1.2.0", "openclaw": {"requires": {"bins": ["openbroker"], "env": ["HYPERLIQUID_PRIVATE_KEY"]}, "primaryEnv": "HYPERLIQUID_PRIVATE_KEY", "install": [{"id": "node", "kind": "node", "package": "openbroker-plugin", "bins": ["openbroker"], "label": "Install openbroker-plugin (npm)"}]}} allowed-tools: ob_account ob_positions ob_funding ob_markets ob_search ob_spot ob_outcomes ob_fills ob_orders ob_order_status ob_fees ob_candles ob_funding_history ob_trades ob_rate_limit ob_funding_scan ob_buy ob_sell ob_limit ob_trigger ob_tpsl ob_cancel ob_spot_buy ob_spot_sell ob_outcome_buy ob_outcome_sell ob_twap ob_twap_cancel ob_twap_status ob_bracket ob_chase ob_watcher_status ob_auto_run ob_auto_stop ob_auto_list Bash(openbroker:*)

---

Open Broker - Hyperliquid Trading CLI

Execute trading operations on Hyperliquid DEX with builder fee support.

Installation

npm install -g openbroker

Quick Start

# 1. Setup (generates wallet, creates config, approves builder fee)
openbroker setup
2. Fund your wallet with USDC on Arbitrum, then deposit at https://app.hyperliquid.xyz/
3. Start trading
openbroker account
openbroker buy --coin ETH --size 0.1

Important: Finding Assets Before Trading

Always search before trading an unfamiliar asset. Hyperliquid has main perps (ETH, BTC, SOL...), HIP-3 perps (xyz:CL, xyz:GOLD, km:USOIL...), spot markets, and HIP-4 outcome markets. Use search to discover the correct ticker:

openbroker search --query GOLD              # Find all GOLD markets across all providers
openbroker search --query oil               # Find oil-related assets (CL, BRENTOIL, USOIL...)
openbroker search --query BTC --type perp   # BTC perps only
openbroker search --query NATGAS --type hip3  # HIP-3 only
openbroker search --query BTC --type outcome  # HIP-4 only
openbroker outcomes --query BTC             # Outcome-specific details

Or with the ob_search plugin tool: { "query": "gold" } or { "query": "oil", "type": "hip3" }

HIP-3 assets use dex:COIN format — e.g., xyz:CL not just CL. If you get an error like "No market data found", search for the asset to find the correct prefixed ticker. Common HIP-3 dexes: xyz, flx, km, hyna, vntl, cash.

Asset IDs (disambiguation)

Every info JSON output includes an assetId field — the canonical Hyperliquid asset index. Prefer it over the coin name 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) | outcome 123 YES → 100001230 |

openbroker search HYPE --json | jq '.[] | {coin, assetId, type, provider}'

Trading commands still take --coin for perps/spot (including HIP-3 dex:COIN) — assetId is for queries, comparisons, and agent state, not order placement. HIP-4 outcome commands take --outcome plus --outcome-side yes|no when using a plain id.

Troubleshooting: CLI Fallback

If an ob_* plugin tool returns unexpected errors, empty results, or crashes, fall back to the equivalent CLI command via Bash. The CLI and plugin tools share the same core code, but the CLI has more mature error handling and output.

Every info command supports --json for structured output. The table below covers the commands with dedicated plugin tools; any other info command (e.g. spot, trades, fees, order-status, rate-limit, funding-history, all-markets) can be run as openbroker --json for the same effect.

| Plugin Tool | CLI Equivalent | |-------------|---------------| | ob_account | openbroker account --json | | ob_positions | openbroker positions --json | | ob_funding | openbroker funding --json --include-hip3 | | ob_markets | openbroker markets --json --include-hip3 | | ob_search | openbroker search --query --json | | ob_spot | openbroker spot --json (or --balances --json) | | ob_outcomes | openbroker outcomes --json (or --query --json) | | ob_fills | openbroker fills --json | | ob_orders | openbroker orders --json | | ob_order_status | openbroker order-status --oid --json | | ob_fees | openbroker fees --json | | ob_candles | openbroker candles --coin --json | | ob_funding_history | openbroker funding-history --coin --json | | ob_trades | openbroker trades --coin --json | | ob_rate_limit | openbroker rate-limit --json | | ob_funding_scan | openbroker funding-scan --json | | ob_buy | openbroker buy --coin --size | | ob_sell | openbroker sell --coin --size | | ob_limit | openbroker limit --coin --side --size --price | | ob_tpsl | openbroker tpsl --coin --tp --sl | | ob_cancel | openbroker cancel --all or --coin | | ob_outcome_buy | openbroker outcome-buy --outcome --outcome-side yes --size | | ob_outcome_sell | openbroker outcome-sell --outcome --outcome-side yes --size | | ob_auto_run | openbroker auto run