Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Tencent SkillHub ยท Developer Tools
Open-broker
Hyperliquid trading plugin with background position monitoring. Execute market orders, limit orders, manage positions, view funding rates, and run trading st...
skill openclawclawhub Free
Hyperliquid trading plugin with background position monitoring. Execute market orders, limit orders, manage positions, view funding rates, and run trading st...
โฌ 0 downloads โ
0 stars Unverified but indexed
Install for OpenClaw
Quick setup
- Download the package from Yavira.
- Extract the archive and review SKILL.md first.
- Import or place the package into your OpenClaw setup.
Package facts
- Download mode
- Yavira redirect
- Package format
- ZIP package
- Source platform
- Tencent SkillHub
- What's included
- SKILL.md
Validation
- Use the Yavira download entry.
- Review SKILL.md after the package is downloaded.
- Confirm the extracted package contains the expected setup assets.
Install with your agent
Agent handoff
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
New install
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
Upgrade existing
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Trust & source
Release facts
- Source
- Tencent SkillHub
- Verification
- Indexed source record
- Version
- 1.0.67
Provenance
- Publisher
- ya7ya
- Source page
- View original listing
- Canonical URL
- Open canonical page
Documentation
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...), and spot 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 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.
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. Plugin ToolCLI Equivalentob_accountopenbroker account --jsonob_positionsopenbroker positions --jsonob_fundingopenbroker funding --json --include-hip3ob_marketsopenbroker markets --json --include-hip3ob_searchopenbroker search --query <QUERY>ob_buyopenbroker buy --coin <COIN> --size <SIZE>ob_sellopenbroker sell --coin <COIN> --size <SIZE>ob_limitopenbroker limit --coin <COIN> --side <SIDE> --size <SIZE> --price <PRICE>ob_tpslopenbroker tpsl --coin <COIN> --tp <PRICE> --sl <PRICE>ob_cancelopenbroker cancel --all or --coin <COIN>ob_fillsopenbroker fills --jsonob_ordersopenbroker orders --jsonob_funding_scanopenbroker funding-scan --jsonob_candlesopenbroker candles --coin <COIN> --jsonob_auto_runopenbroker auto run <script> [--dry]ob_auto_stop(stop via SIGINT when using CLI)ob_auto_listopenbroker auto list When to use CLI fallback: Plugin tool returns null, empty data, or throws an error You need data the plugin tool doesn't expose (e.g., --verbose debug output) Long-running operations (strategies, TWAP) โ the CLI handles timeouts and progress better Add --dry to any trading CLI command to preview without executing. Add --json to info commands for structured output.
Setup
openbroker setup # One-command setup (wallet + config + builder approval) openbroker approve-builder --check # Check builder fee status (for troubleshooting) The setup command offers three modes: Generate fresh wallet (recommended for agents) โ creates a dedicated trading wallet with builder fee auto-approved. No browser steps needed โ just fund with USDC and start trading. Import existing key โ use a private key you already have Generate API wallet โ creates a restricted wallet that can trade but cannot withdraw. Requires browser approval from a master wallet. For options 1 and 2, setup saves config and approves the builder fee automatically. For option 3 (API wallet), see the API Wallet Setup section below.
Fresh Wallet Setup (Recommended for Agents)
The simplest setup for agents. A fresh wallet is generated, the builder fee is auto-approved, and the agent is ready to trade immediately after funding. Flow: Run openbroker setup and choose option 1 ("Generate a fresh wallet") The CLI generates a wallet, saves the config, and approves the builder fee automatically Fund the wallet by sending USDC from your Hyperliquid account to the agent's wallet address using the Send feature on https://app.hyperliquid.xyz/. Funding should be done on Hyperliquid L1 only. Start trading
API Wallet Setup (Alternative)
API wallets can place trades on behalf of a master account but cannot withdraw funds. Use this if you prefer to keep funds in your existing wallet and only delegate trading access. Flow: Run openbroker setup and choose option 3 ("Generate API wallet") The CLI generates a keypair and prints an approval URL (e.g. https://openbroker.dev/approve?agent=0xABC...) The agent owner opens the URL in a browser and connects their master wallet (MetaMask etc.) The master wallet signs two transactions: ApproveAgent (authorizes the API wallet) and ApproveBuilderFee (approves the 1 bps fee) The CLI detects the approval automatically and saves the config After setup, the config will contain: HYPERLIQUID_PRIVATE_KEY=0x... # API wallet private key HYPERLIQUID_ACCOUNT_ADDRESS=0x... # Master account address HYPERLIQUID_NETWORK=mainnet Important for agents: When using an API wallet, pass the approval URL to the agent owner (the human who controls the master wallet). The owner must approve in a browser before the agent can trade. The CLI waits up to 10 minutes for the approval. If it times out, re-run openbroker setup.
Account Info
openbroker account # Balance, equity, margin openbroker account --orders # Include open orders openbroker positions # Open positions with PnL openbroker positions --coin ETH # Specific coin
Funding Rates
openbroker funding --top 20 # Top 20 by funding rate openbroker funding --coin ETH # Specific coin
Markets
openbroker markets --top 30 # Top 30 main perps openbroker markets --coin BTC # Specific coin
All Markets (Perps + Spot + HIP-3)
openbroker all-markets # Show all markets openbroker all-markets --type perp # Main perps only openbroker all-markets --type hip3 # HIP-3 perps only openbroker all-markets --type spot # Spot markets only openbroker all-markets --top 20 # Top 20 by volume
Search Markets (Find assets across providers)
openbroker search --query GOLD # Find all GOLD markets openbroker search --query BTC # Find BTC across all providers openbroker search --query ETH --type perp # ETH perps only
Spot Markets
openbroker spot # Show all spot markets openbroker spot --coin PURR # Show PURR market info openbroker spot --balances # Show your spot balances openbroker spot --top 20 # Top 20 by volume
Trade Fills
openbroker fills # Recent fills openbroker fills --coin ETH # ETH fills only openbroker fills --coin BTC --side buy --top 50
Order History
openbroker orders # Recent orders (all statuses) 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
Order Status
openbroker order-status --oid 123456789 # Check specific order openbroker order-status --oid 0x1234... # By client order ID
Fee Schedule
openbroker fees # Fee tier, rates, and volume
Candle Data (OHLCV)
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
Funding History
openbroker funding-history --coin ETH # Last 24h openbroker funding-history --coin BTC --hours 168 # Last 7 days
Recent Trades (Tape)
openbroker trades --coin ETH # Last 30 trades openbroker trades --coin BTC --top 50 # Last 50 trades
Rate Limit
openbroker rate-limit # API usage and capacity
Funding Rate Scanner (Cross-Dex)
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
HIP-3 Perp Trading
All trading commands support HIP-3 assets using dex:COIN syntax: openbroker buy --coin xyz:CL --size 1 # Buy crude oil on xyz dex openbroker sell --coin xyz:BRENTOIL --size 1 # Sell brent oil openbroker limit --coin xyz:GOLD --side buy --size 0.1 --price 2500 openbroker funding-arb --coin xyz:CL --size 5000 # Funding arb on HIP-3
Market Orders (Quick)
openbroker buy --coin ETH --size 0.1 openbroker sell --coin BTC --size 0.01 openbroker buy --coin SOL --size 5 --slippage 100 # Custom slippage (bps)
Market Orders (Full)
openbroker market --coin ETH --side buy --size 0.1 openbroker market --coin BTC --side sell --size 0.01 --slippage 100
Limit Orders
openbroker limit --coin ETH --side buy --size 1 --price 3000 openbroker limit --coin SOL --side sell --size 10 --price 200 --tif ALO
Set TP/SL on Existing Position
# Set take profit at $40, stop loss at $30 openbroker tpsl --coin HYPE --tp 40 --sl 30 # Set TP at +10% from entry, SL at entry (breakeven) openbroker tpsl --coin HYPE --tp +10% --sl entry # Set only stop loss at -5% from entry openbroker tpsl --coin ETH --sl -5% # Partial position TP/SL openbroker tpsl --coin ETH --tp 4000 --sl 3500 --size 0.5
Trigger Orders (Standalone TP/SL)
# Take profit: sell when price rises to $40 openbroker trigger --coin HYPE --side sell --size 0.5 --trigger 40 --type tp # Stop loss: sell when price drops to $30 openbroker trigger --coin HYPE --side sell --size 0.5 --trigger 30 --type sl
Cancel Orders
openbroker cancel --all # Cancel all orders openbroker cancel --coin ETH # Cancel ETH orders only openbroker cancel --oid 123456 # Cancel specific order
TWAP (Time-Weighted Average Price)
# Execute 1 ETH buy over 1 hour (auto-calculates slices) openbroker twap --coin ETH --side buy --size 1 --duration 3600 # Custom intervals with randomization openbroker twap --coin BTC --side sell --size 0.5 --duration 1800 --intervals 6 --randomize 20
Scale In/Out (Grid Orders)
# Place 5 buy orders ranging 2% below current price openbroker scale --coin ETH --side buy --size 1 --levels 5 --range 2 # Scale out with exponential distribution openbroker scale --coin BTC --side sell --size 0.5 --levels 4 --range 3 --distribution exponential --reduce
Bracket Order (Entry + TP + SL)
# Long ETH with 3% take profit and 1.5% stop loss openbroker bracket --coin ETH --side buy --size 0.5 --tp 3 --sl 1.5 # Short with limit entry openbroker bracket --coin BTC --side sell --size 0.1 --entry limit --price 100000 --tp 5 --sl 2
Chase Order (Follow Price)
# Chase buy with ALO orders until filled openbroker chase --coin ETH --side buy --size 0.5 --timeout 300 # Aggressive chase with tight offset openbroker chase --coin SOL --side buy --size 10 --offset 2 --timeout 60
Funding Arbitrage
# Collect funding on ETH if rate > 25% annualized openbroker funding-arb --coin ETH --size 5000 --min-funding 25 # Run for 24 hours, check every 30 minutes openbroker funding-arb --coin BTC --size 10000 --duration 24 --check 30 --dry
Grid Trading
# ETH grid from $3000-$4000 with 10 levels, 0.1 ETH per level openbroker grid --coin ETH --lower 3000 --upper 4000 --grids 10 --size 0.1 # Accumulation grid (buys only) openbroker grid --coin BTC --lower 90000 --upper 100000 --grids 5 --size 0.01 --mode long
DCA (Dollar Cost Averaging)
# Buy $100 of ETH every hour for 24 hours openbroker dca --coin ETH --amount 100 --interval 1h --count 24 # Invest $5000 in BTC over 30 days with daily purchases openbroker dca --coin BTC --total 5000 --interval 1d --count 30
Market Making Spread
# Market make ETH with 0.1 size, 10bps spread openbroker mm-spread --coin ETH --size 0.1 --spread 10 # Tighter spread with position limit openbroker mm-spread --coin BTC --size 0.01 --spread 5 --max-position 0.1
Maker-Only MM (ALO orders)
# Market make using ALO (post-only) orders - guarantees maker rebates openbroker mm-maker --coin HYPE --size 1 --offset 1 # Wider offset for volatile assets openbroker mm-maker --coin ETH --size 0.1 --offset 2 --max-position 0.5
Limit Orders vs Trigger Orders
Limit Orders (openbroker limit): Execute immediately if price is met Rest on the order book until filled or cancelled A limit sell BELOW current price fills immediately (taker) NOT suitable for stop losses Trigger Orders (openbroker trigger, openbroker tpsl): Stay dormant until trigger price is reached Only activate when price hits the trigger level Proper way to set stop losses and take profits Won't fill prematurely
When to Use Each
ScenarioCommandBuy at specific price below marketopenbroker limitSell at specific price above marketopenbroker limitStop loss (exit if price drops)openbroker trigger --type slTake profit (exit at target)openbroker trigger --type tpAdd TP/SL to existing positionopenbroker tpsl
Common Arguments
All commands support --dry for dry run (preview without executing). ArgumentDescription--coinAsset symbol (ETH, BTC, SOL, HYPE, etc.)--sideOrder direction: buy or sell--sizeOrder size in base asset--priceLimit price--dryPreview without executing--helpShow command help
Order Arguments
ArgumentDescription--triggerTrigger price (for trigger orders)--typeTrigger type: tp or sl--slippageSlippage tolerance in bps (for market orders)--tifTime in force: GTC, IOC, ALO--reduceReduce-only order
TP/SL Price Formats
FormatExampleDescriptionAbsolute--tp 40Price of $40Percentage up--tp +10%10% above entryPercentage down--sl -5%5% below entryEntry price--sl entryBreakeven stop
Configuration
Config is loaded from (in priority order): Environment variables .env in current directory ~/.openbroker/.env (global config) Run openbroker setup to create the global config interactively. VariableRequiredDescriptionHYPERLIQUID_PRIVATE_KEYYesWallet private key (0x...)HYPERLIQUID_NETWORKNomainnet (default) or testnetHYPERLIQUID_ACCOUNT_ADDRESSNoMaster account address (required for API wallets) The builder fee (1 bps / 0.01%) is hardcoded and not configurable.
OpenClaw Plugin (Optional)
This skill works standalone via Bash โ every command above runs through the openbroker CLI. For enhanced features, the same openbroker npm package also ships as an OpenClaw plugin that you can enable alongside this skill.
What the plugin adds
Structured agent tools (ob_account, ob_buy, ob_limit, etc.) โ typed tool calls with proper input schemas instead of Bash strings. The agent gets structured JSON responses. Background position watcher โ polls your Hyperliquid account every 30s and sends webhook alerts when positions open/close, PnL moves significantly, or margin usage gets dangerous. Automation tools (ob_auto_run, ob_auto_stop, ob_auto_list) โ start, stop, and manage custom trading automations from within the agent. CLI commands โ openclaw ob status and openclaw ob watch for inspecting the watcher.
Enable the plugin
The plugin is bundled in the same openbroker npm package. To enable it in your OpenClaw config: plugins: entries: openbroker: enabled: true config: hooksToken: "your-hooks-secret" # Required for watcher alerts watcher: enabled: true pollIntervalMs: 30000 pnlChangeThresholdPct: 5 marginUsageWarningPct: 80 The plugin reads wallet credentials from ~/.openbroker/.env (set up by openbroker setup), so you don't need to duplicate privateKey in the plugin config unless you want to override.
Webhook setup for watcher alerts
For position alerts to reach the agent, enable hooks in your gateway config: hooks: enabled: true token: "your-hooks-secret" # Must match hooksToken above Without hooks, the watcher still runs and tracks state (accessible via ob_watcher_status), but it can't wake the agent.
Using with or without the plugin
Skill only (no plugin): Use Bash commands (openbroker buy --coin ETH --size 0.1). No background monitoring. Skill + plugin: The agent prefers the ob_* tools when available (structured data), falls back to Bash for commands not covered by tools (strategies, scale). Background watcher sends alerts automatically.
Trading Automations
Automations let you write custom event-driven trading logic as TypeScript scripts. Instead of using the rigid built-in strategies, write exactly the logic you need and OpenBroker handles the polling, event detection, and SDK access.
How Automations Work
An automation is a .ts file that exports a default function. The function receives an AutomationAPI with the full Hyperliquid client, typed event subscriptions, persistent state, and a logger. The runtime polls Hyperliquid every 10s (configurable) and dispatches events when changes are detected.
Writing an Automation
Create a .ts file in ~/.openbroker/automations/ (or any path): // ~/.openbroker/automations/funding-scalp.ts export default function(api) { const COIN = 'ETH'; api.on('funding_update', async ({ coin, annualized }) => { if (coin !== COIN) return; if (annualized > 0.5 && !api.state.get('isShort')) { api.log.info('High positive funding โ going short'); await api.client.marketOrder(COIN, false, 0.1); api.state.set('isShort', true); } else if (annualized < -0.1 && api.state.get('isShort')) { api.log.info('Funding normalized โ closing short'); await api.client.marketOrder(COIN, true, 0.1); api.state.set('isShort', false); } }); api.onStop(async () => { if (api.state.get('isShort')) { api.log.warn('Closing short on shutdown'); await api.client.marketOrder('ETH', true, 0.1); api.state.set('isShort', false); } }); }
AutomationAPI Reference
Property / MethodDescriptionapi.clientFull HyperliquidClient โ marketOrder(), limitOrder(), triggerOrder(), cancelAll(), getUserStateAll(), getAllMids(), updateLeverage(), and 35+ more methodsapi.on(event, handler)Subscribe to a market/account event (see Events below)api.every(ms, handler)Run a handler on a recurring interval (aligned to poll loop)api.onStart(handler)Called after all handlers are registered, before first pollapi.onStop(handler)Called on shutdown (SIGINT). Use for cleanup โ close positions, cancel ordersapi.onError(handler)Called when a handler throws. Error is already logged โ use for recovery logicapi.state.get(key)Get a persisted value (survives restarts, stored in ~/.openbroker/state/)api.state.set(key, value)Set a persisted valueapi.state.delete(key)Delete a persisted valueapi.state.clear()Clear all stateapi.publish(message, options?)Send a message to the OpenClaw agent via webhook. Triggers an agent turn โ the agent receives the message and can notify the user, take action, etc. Returns true if delivered. Options: { name?, wakeMode?, deliver?, channel? }api.log.info/warn/error/debug(msg)Structured loggerapi.utilsroundPrice, roundSize, sleep, normalizeCoin, formatUsd, annualizeFundingRateapi.idAutomation ID (filename or --id flag)api.dryRuntrue if running with --dry (write methods are intercepted)
Events
EventPayloadWhentick{ timestamp, pollCount }Every poll cycle (default: 10s)price_change{ coin, oldPrice, newPrice, changePct }Mid price moved > 0.01% between pollsfunding_update{ coin, fundingRate, annualized, premium }Every poll for all assetsposition_opened{ coin, side, size, entryPrice }New position detectedposition_closed{ coin, previousSize, entryPrice }Position no longer presentposition_changed{ coin, oldSize, newSize, entryPrice }Position size changedpnl_threshold{ coin, unrealizedPnl, changePct, positionValue }PnL moved > 5% of position valuemargin_warning{ marginUsedPct, equity, marginUsed }Margin usage > 80%
Event Details โ Choosing the Right Event
tick โ The universal heartbeat Fires every single poll cycle (default: 10s) regardless of market conditions. Use this when you need to check something on every poll โ absolute price thresholds, custom conditions, periodic account checks. This is the most reliable event because it always fires. Payload: { timestamp: number, pollCount: number } When to use: Checking if a price is above/below an absolute threshold (e.g. "alert me when ETH < $3000") Custom conditions that don't fit other events (e.g. "if I have no positions and funding is high, enter") Periodic tasks that need to run every poll (though api.every() is better for longer intervals) Example โ absolute price alert: api.on('tick', async () => { const mids = await api.client.getAllMids(); const price = parseFloat(mids['HYPE']); if (price < 38 && !api.state.get('alerted')) { api.state.set('alerted', true); await api.publish(`HYPE dropped below $38 โ now at $${price.toFixed(3)}`); } }); Note: tick does not include price data in its payload โ you must fetch it yourself via api.client.getAllMids(). This is because tick fires before any other event processing. If you only care about price movements, use price_change instead. price_change โ Relative price movements Fires when a coin's mid price moves โฅ 0.01% compared to the previous poll. This filters out rounding noise while catching virtually any real price movement. The comparison is between consecutive polls (not from a fixed baseline), so it detects incremental changes. Payload: { coin: string, oldPrice: number, newPrice: number, changePct: number } When to use: Reacting to price movements (breakouts, momentum, mean reversion) Monitoring specific coins for volatility Building price-triggered entry/exit logic When NOT to use: Checking if price is above/below a fixed threshold โ use tick instead, because price_change only fires on relative movement between polls. During slow drifts (e.g. price slowly declining $0.001/s), the change between any two 10s polls may be < 0.01%, so the event won't fire even though the price has crossed your threshold. Example โ momentum detector: api.on('price_change', async ({ coin, changePct, newPrice }) => { if (coin !== 'ETH') return; if (changePct > 0.5) { api.log.info(`ETH surging +${changePct.toFixed(2)}% โ price $${newPrice}`); // Enter long on strong upward momentum } }); funding_update โ Funding rate data Fires every poll for every asset that has funding rate data. This is high-frequency โ if there are 150 perp assets, this fires 150 times per poll. Filter by coin in your handler. Payload: { coin: string, fundingRate: number, annualized: number, premium: number } fundingRate โ the raw hourly funding rate (e.g. 0.0001 = 0.01%/hr) annualized โ annualized rate (fundingRate ร 8760 ร 100, as a percentage) premium โ the premium component When to use: Funding rate arbitrage strategies Monitoring for extreme funding (entry/exit signals) Scanning for highest/lowest funding across all assets Example โ funding scalp: api.on('funding_update', async ({ coin, annualized }) => { if (coin !== 'ETH') return; if (annualized > 50 && !api.state.get('isShort')) { api.log.info(`ETH funding at ${annualized.toFixed(1)}% annualized โ shorting`); await api.client.marketOrder('ETH', false, 0.1); api.state.set('isShort', true); } }); position_opened โ New position detected Fires when a position appears that wasn't present in the previous poll. Useful for tracking entries made by other systems or confirming your own orders filled. Payload: { coin: string, side: 'long' | 'short', size: number, entryPrice: number } When to use: Setting TP/SL on new positions automatically Logging/alerting when positions are opened (by you or another system) Starting position-specific monitoring Example โ auto TP/SL on new positions: api.on('position_opened', async ({ coin, side, size, entryPrice }) => { const tpPrice = side === 'long' ? entryPrice * 1.05 : entryPrice * 0.95; const slPrice = side === 'long' ? entryPrice * 0.97 : entryPrice * 1.03; await api.client.takeProfit(coin, side !== 'long', size, tpPrice); await api.client.stopLoss(coin, side !== 'long', size, slPrice); api.log.info(`Set TP at ${tpPrice} / SL at ${slPrice} for ${coin}`); }); position_closed โ Position gone Fires when a position that existed in the previous poll is no longer present. The position was either closed by you, liquidated, or filled by TP/SL. Payload: { coin: string, previousSize: number, entryPrice: number } When to use: Logging/alerting when positions close Cleaning up related orders or state Re-entry logic after a position closes Example: api.on('position_closed', async ({ coin, previousSize, entryPrice }) => { api.log.info(`${coin} position closed (was ${previousSize} @ ${entryPrice})`); api.state.delete(`${coin}_tp`); await api.publish(`Position closed: ${coin} (entry: $${entryPrice})`); }); position_changed โ Size or direction changed Fires when an existing position's size changes (partial close, add to position, or flip direction). Does NOT fire when a new position opens or an existing one fully closes โ use position_opened and position_closed for those. Payload: { coin: string, oldSize: number, newSize: number, entryPrice: number } oldSize/newSize are signed: positive = long, negative = short When to use: Detecting partial closes or position scaling Adjusting TP/SL when position size changes Tracking DCA entries Example: api.on('position_changed', async ({ coin, oldSize, newSize }) => { if (Math.abs(newSize) > Math.abs(oldSize)) { api.log.info(`${coin} position increased: ${oldSize} โ ${newSize}`); } else { api.log.info(`${coin} position reduced: ${oldSize} โ ${newSize}`); } }); pnl_threshold โ Significant PnL movement Fires when unrealized PnL changes by โฅ 5% of position value between consecutive polls. This is a large move detector โ useful for risk management alerts rather than routine monitoring. Payload: { coin: string, unrealizedPnl: number, changePct: number, positionValue: number } changePct โ the PnL change as a percentage of total position value (not % of PnL itself) When to use: Risk alerts for large PnL swings Auto-close or reduce positions on sudden adverse moves Escalating alerts to the user via api.publish() Example: api.on('pnl_threshold', async ({ coin, unrealizedPnl, changePct }) => { if (unrealizedPnl < 0) { await api.publish( `โ ๏ธ ${coin} PnL dropped sharply: $${unrealizedPnl.toFixed(2)} (${changePct.toFixed(1)}% of position)`, { name: 'pnl-alert' }, ); } }); margin_warning โ High margin usage Fires when margin usage exceeds 80% of equity. After the first trigger, it only fires again if margin usage increases by another 5 percentage points (prevents spam). Resets when margin drops back below 80%. Payload: { marginUsedPct: number, equity: number, marginUsed: number } When to use: Automated risk reduction (close smallest position to free margin) Alerting the user before liquidation risk Pausing new entries when margin is high Example: api.on('margin_warning', async ({ marginUsedPct, equity }) => { await api.publish( `๐จ Margin at ${marginUsedPct.toFixed(1)}% โ equity: $${equity.toFixed(2)}. Consider reducing exposure.`, { name: 'margin-alert' }, ); });
Choosing the Right Event โ Quick Guide
Use caseBest eventWhyAlert when price crosses a fixed leveltickFires every poll โ no minimum change thresholdReact to price momentum/volatilityprice_changeProvides relative change data between pollsFunding rate strategyfunding_updateGives annualized rate directlyAuto TP/SL on new positionsposition_openedFires exactly when a new position appearsLog when positions closeposition_closedFires when position disappearsTrack position scalingposition_changedFires on size changes onlyRisk management โ PnL spikespnl_thresholdOnly fires on large moves (โฅ5% of position value)Risk management โ marginmargin_warningFires at 80%+ margin usagePeriodic task (DCA, rebalance)api.every(ms, fn)Better than tick for longer intervals
Client Methods Available
The api.client object exposes the full Hyperliquid SDK: Trading: marketOrder(coin, isBuy, size), limitOrder(coin, isBuy, size, price), triggerOrder(coin, isBuy, size, triggerPx, isMarket), takeProfit(coin, isBuy, size, triggerPx), stopLoss(coin, isBuy, size, triggerPx), cancel(coin, oid), cancelAll(coin?) Market Data: getAllMids(), getMetaAndAssetCtxs(), getRecentTrades(coin), getCandleSnapshot(coin, interval), getFundingHistory(coin), getPredictedFundings() Account: getUserStateAll(), getOpenOrders(), getUserFills(), getUserFunding(), getHistoricalOrders(), getUserFees(), getUserRateLimit(), getSpotBalances() Leverage: updateLeverage(coin, leverage, isIsolated?)
Example: Price Breakout
// ~/.openbroker/automations/breakout.ts export default function(api) { const COIN = 'ETH'; const BREAKOUT_PCT = 2; // 2% move triggers entry const SIZE = 0.5; let basePrice = null; api.onStart(async () => { const mids = await api.client.getAllMids(); basePrice = parseFloat(mids[COIN]); api.log.info(`Watching ${COIN} from $${basePrice} for ${BREAKOUT_PCT}% breakout`); }); api.on('price_change', async ({ coin, newPrice }) => { if (coin !== COIN || !basePrice) return; const totalChange = ((newPrice - basePrice) / basePrice) * 100; if (Math.abs(totalChange) >= BREAKOUT_PCT && !api.state.get('inPosition')) { const side = totalChange > 0; // true = long, false = short api.log.info(`Breakout! ${totalChange.toFixed(2)}% โ entering ${side ? 'long' : 'short'}`); await api.client.marketOrder(COIN, side, SIZE); api.state.set('inPosition', true); } }); }
Example: Scheduled DCA
// ~/.openbroker/automations/hourly-dca.ts export default function(api) { const COIN = 'ETH'; const USD_PER_BUY = 100; // Buy $100 of ETH every hour api.every(60 * 60 * 1000, async () => { const mids = await api.client.getAllMids(); const price = parseFloat(mids[COIN]); const size = parseFloat(api.utils.roundSize(USD_PER_BUY / price, 4)); await api.client.marketOrder(COIN, true, size); const count = (api.state.get('buyCount') || 0) + 1; api.state.set('buyCount', count); api.log.info(`DCA #${count}: bought ${size} ${COIN} at $${price}`); }); }
Example: Margin Guardian
// ~/.openbroker/automations/margin-guard.ts export default function(api) { api.on('margin_warning', async ({ marginUsedPct, equity }) => { api.log.warn(`Margin at ${marginUsedPct.toFixed(1)}% โ reducing positions`); // Close the smallest position to free margin const state = await api.client.getUserStateAll(); const positions = state.assetPositions .filter(p => parseFloat(p.position.szi) !== 0) .sort((a, b) => Math.abs(parseFloat(a.position.positionValue)) - Math.abs(parseFloat(b.position.positionValue))); if (positions.length > 0) { const pos = positions[0].position; const size = Math.abs(parseFloat(pos.szi)); const isBuy = parseFloat(pos.szi) < 0; // Close short = buy, close long = sell api.log.info(`Closing smallest position: ${pos.coin} (${pos.szi})`); await api.client.marketOrder(pos.coin, isBuy, size); } }); }
Publishing to the Agent (Webhooks)
Use api.publish() to send messages back to the OpenClaw agent. This triggers an agent turn โ the agent receives the message and can notify the user via their preferred channel, take trading actions, or log the event. // Simple notification await api.publish(`ETH broke above $4000 โ current price: $${price}`); // With options await api.publish(`Margin at ${pct}% โ positions at risk`, { name: 'margin-alert', // appears in logs wakeMode: 'now', // 'now' (default) or 'next-heartbeat' channel: 'slack', // target channel (optional) }); api.publish() returns true if delivered, false if webhooks are not configured (no hooks token). It requires OPENCLAW_HOOKS_TOKEN to be set (automatically configured when running as an OpenClaw plugin). Example: Price alert automation with publish // ~/.openbroker/automations/price-alert.ts export default function(api) { const COIN = 'ETH'; const THRESHOLD = 4000; api.on('price_change', async ({ coin, newPrice, changePct }) => { if (coin !== COIN) return; const crossed = api.state.get<boolean>('crossed', false); if (!crossed && newPrice >= THRESHOLD) { api.state.set('crossed', true); await api.publish( `${COIN} crossed above $${THRESHOLD}! Price: $${newPrice.toFixed(2)} (+${changePct.toFixed(2)}%)`, ); } else if (crossed && newPrice < THRESHOLD) { api.state.set('crossed', false); } }); }
Running Automations
CLI: openbroker auto run my-strategy --dry # Test without trading openbroker auto run ./funding-scalp.ts # Run from path openbroker auto run my-strategy --poll 5000 # Poll every 5s openbroker auto list # Show available scripts openbroker auto status # Show running automations Plugin tools (for OpenClaw agents): ob_auto_run โ { "script": "funding-scalp", "dry": true } โ start an automation ob_auto_stop โ { "id": "funding-scalp" } โ stop a running automation ob_auto_list โ {} โ list available and running automations Options: FlagDescriptionDefault--dryIntercept write methods โ no real tradesfalse--verboseShow debug outputfalse--id <name>Custom automation IDfilename--poll <ms>Poll interval in milliseconds10000 Guidelines for agents writing automations: Risk & Safety (mandatory): Always attach a liquidation monitoring automation to every open position. Subscribe to margin_warning and pnl_threshold events so the user is never blindsided by liquidation risk. If no margin/liquidation automation is already running, create one before placing trades. Use api.publish() to notify the user of important events โ position opens/closes, TP/SL triggers, large PnL swings, margin warnings, errors, and any situation that requires human attention. Do NOT silently handle critical events. Always register an api.onStop() handler to clean up โ cancel open orders and close positions (or at minimum alert the user) on shutdown. Never leave orphaned orders or unmanaged positions. Do NOT use --dry unless the user explicitly asks for it. Automations should run live by default. Never place trades without validating that sufficient margin is available. Check account state before sizing orders. Cap position sizes relative to account equity. Do not risk more than a reasonable percentage of equity on a single trade unless the user explicitly specifies the size. Always set TP/SL on new positions โ either within the automation or by confirming the user has them set. Unprotected positions are a liability. State & Reliability: Use api.state to track position state, entry prices, and flags across restarts. Never rely on in-memory variables alone โ automations persist across gateway restarts and are automatically restarted. Use idempotency guards (api.state.get/set) to prevent duplicate orders. Events can fire multiple times for the same condition across polls โ always check state before placing orders. The runtime catches errors per handler โ one failing handler won't crash others, but always handle expected errors (e.g. order rejection, insufficient margin) gracefully within handlers. Communication: Use api.publish() to send alerts/events back to the OpenClaw agent โ do NOT manually construct webhook requests. Publish on: position opened/closed, TP/SL triggered, PnL threshold exceeded, margin warning, automation errors, and any automated trade execution. The user should always know what the automation did and why. Include actionable context in publish messages โ coin, price, size, PnL, and what happened โ so the user can make informed decisions without checking the terminal. General: Scripts are loaded from ~/.openbroker/automations/ by name, or from any absolute path. All trading commands support HIP-3 assets (api.client.marketOrder('xyz:CL', true, 1)). Automations persist across gateway restarts โ they are automatically restarted when the gateway comes back up. Prefer api.every(ms, fn) over tick for periodic tasks with intervals longer than the poll cycle.
Risk Warning
Always use --dry first to preview orders Start with small sizes on testnet (HYPERLIQUID_NETWORK=testnet) Monitor positions and liquidation prices Use --reduce for closing positions only
Category context
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Source: Tencent SkillHub
Largest current source with strong distribution and engagement signals.
Package contents
Included in package
1 Docs
- SKILL.md