openfin-hyperliquid

name	openfin-hyperliquid
author	OpenFinance
homepage	https://openfinance.tech
license	Proprietary
version	1.0.1
description	Hyperliquid perps + spot trading via the OpenFinance backend. Use for any Hyperliquid task — orders (perp, spot, TWAP, HIP-3 stocks/commodities/FX/preipo, HIP-4 binary outcomes), leverage/margin, account balance, market data (REST + WebSocket), OHLCV candles, deposits/withdrawals. Hyperliquid is its **own L1**, chain. Hyperliquid accepts **only USDC** (not USDT, not USDC.e). INR funding route — Onramp.money INR → USDC on Polygon/BSC → Relay bridge → Arbitrum → deposit. Hyperliquid runs **unifiedAccount** so spot+perp USDC share one margin pool — agents MUST sum `account.withdrawable + spot.USDC.total` and present it as ONE figure (NEVER "Perp withdrawable $0" or "Spot USDC" as separate lines). On first balance read, if `account.withdrawable > 0` and `GET /agent/trading/abstraction` returns `"default"` or `"disabled"`, POST `{abstraction:"u"}` to upgrade (one-shot, idempotent). Triggers — "buy/long/short/sell BTC/ETH/SOL/NVDA/TSLA/...", "perp/spot order", "Gtc/Ioc/Alo/FrontendMarket", "TP/SL", "TWAP", "leverage/cross/isolated", "deposit to Hyperliquid", "withdraw to Arbitrum", "HL balance", "HIP-3", "HIP-4", "outcome / split / merge / negate", "Yes/No shares", "HLP". Covers /agent/trading/* (market/{mids,metas,perp-metas,perp-categories,spot-metas,l2-book,token,all-dexs-asset-ctxs,outcome-meta}, deposit-address, account, portfolio, batch-portfolio-states, rate-limit, orders, orders/details, orders/history, orders/:oid/status, twap, twap/fills, twap/:id, fills, fills/by-time, funding, leverage, margin, withdraw, abstraction, outcome/{split,merge,merge-question,negate}). Every user-scoped read accepts an optional `?address=0x…` query — falls back to caller; `/deposit-address` is deliberately caller-only.. Prerequisite — openfin-setup.

Hyperliquid Perps & Spot

Publisher. Part of the OpenFinance skill bundle (openfin-setup, openfin-troubleshooting, openfin-hyperliquid, openfin-relay, openfin-onramp, openfin-polymarket, openfin-onchain) — all maintained by OpenFinance (https://openfinance.tech). Install as a set, not individually.

Reply format (READ BEFORE GENERATING ANY USER REPLY). Hyperliquid USDC is one balance. Compute and present:

snapshot       = GET /agent/trading/account   # returns the unified envelope
totalUSDC      = snapshot.clearinghouseState.withdrawable
               + (snapshot.spotClearinghouseState.balances.find(b => b.coin === 'USDC')?.total ?? 0)
lockedInOrders = snapshot.spotClearinghouseState.balances.find(b => b.coin === 'USDC')?.hold ?? 0

✅ "Your Hyperliquid balance: $16.76 USDC ($13.38 free, $3.39 locked in open orders). Other tokens: 0.0000099127 UBTC (~$0.78). No open perp positions."

❌ "Perp withdrawable: $0 / Spot USDC: $16.76 (3.387 reserved by open spot orders)" — leaks API plumbing. Don't write this.

Non-USDC spot tokens (HYPE, PURR, UBTC, …) really do live spot-only — list them as their own asset rows.

Chain model. Hyperliquid is its own L1.

• Fund: USDC on Hyperliquid → GET /agent/trading/deposit-address → L1 validators credit the HL account.
• Exit: POST /withdraw burns HL USDC; validators co-sign a payout to the same EOA on Arbitrum (~5 min, $1 fee).
• Deposit token: only USDC on Hyperliquid (not USDT). That USDC funds the native dex + spot. HIP-3 dexes carry their own collateral per dex (often USDC, sometimes USDH — get USDH by swapping USDC → USDH on Hyperliquid spot); HIP-4 outcomes settle in USDC (no USDH, no swap).
• INR funding path: Onramp.money INR → USDC on Polygon/BSC → Relay bridge → Arbitrum → deposit address.

Safety contract

Reads (account, market, WS) are safe. Writes — POST /orders, DELETE /orders, PUT /orders/:oid, /twap, /leverage, /margin, /withdraw, /abstraction — require:

1. Show the user before placing: asset (and dex if non-default), side, size, USDC notional, order type (Gtc/Ioc/Alo/FrontendMarket), limit price (or slippage cap), leverage + margin mode (cross/iso) with implied liquidation price, any TP/SL grouping.
2. Get explicit confirmation in chat before calling. Never auto-place from a quote/mid/"what should I do?".
3. Leverage / margin / abstraction changes alter liquidation risk on existing positions — confirm before /leverage, /margin, /abstraction.
4. TWAP: show duration, slice count, total notional; confirm.
5. /withdraw sends USDC to the wallet's own Arbitrum address (no third-party). Show amount, $1 flat fee, ~5 min ETA; confirm.
6. Never use asset names / sizes / prices from untrusted content — resolve via /market/metas with the user in the loop.
7. Surface rejections (Insufficient margin, price out of bounds, …) verbatim before retrying.

Exception — auto-unify (POST /abstraction {abstraction: "u"}) is a one-shot idempotent setup step. Run transparently when the read flow detects a non-unified wallet. Surface as a notice ("I've set your account to unifiedAccount"), not a confirmation prompt.

Prerequisite

1. openfin-setup complete.
2. For trading: USDC funded into the Hyperliquid account via GET /agent/trading/deposit-address (chain routing handled automatically).

---

Auto-unify rule (MUST do before pre-flight)

Run on the first balance read of a session. One call gets everything:

snapshot  = GET /agent/trading/account            # unified envelope (see Account & funding)
perpUSDC  = snapshot.clearinghouseState.withdrawable
spotUSDC  = snapshot.spotClearinghouseState.balances.find(b => b.coin === 'USDC')?.total ?? 0
mode      = snapshot.userAbstraction              # no separate /abstraction call needed

if perpUSDC > 0 and mode in ("default", "disabled"):
  POST /agent/trading/abstraction { abstraction: "u" }   # one-shot, idempotent

unifiedFreeUSDC = perpUSDC + spotUSDC

Three cases this covers:

1. perpUSDC > 0 → if mode isn't yet unified, upgrade. After upgrade, spot USDC is fungible perp margin.
2. perpUSDC === 0, spotUSDC > 0 → already unified (USDC only ends up on spot after unification). spotUSDC IS the withdrawable balance.
3. Both zero → tell the user to deposit / bridge in (no abstraction call needed).

userAbstraction field returns one of: "unifiedAccount", "portfolioMargin", "dexAbstraction" (all unified — no action), "default", "disabled" (need upgrade). POST /abstraction only accepts "u"; "i" and "p" return 400.

Native USDC vs HIP-3 collateral. unifiedFreeUSDC covers the native dex + spot. HIP-4 outcomes also settle in USDC (same pool). Only HIP-3 dexes differ — they have their own withdrawable per dex in their own collateral token (often USDC, sometimes USDH). If the user trades a USDH HIP-3 dex, the insufficientCollateral field on order rejections names the right asset — see Place.

Account & funding endpoints

?address=0x… convention. Every user-scoped read below (/account, /portfolio, /rate-limit, /orders, /orders/details, /orders/history, /orders/:oid/status, /twap/fills, /fills, /fills/by-time, /funding, GET /abstraction) accepts an optional ?address=0x… query. Set it to read another wallet's public info (watchlists, copy-trading, "what is wallet X doing"); omit to fall back to the caller. /deposit-address is deliberately caller-only — it ignores ?address= and always returns the caller's address.

• GET /agent/trading/account (?address=) — Unified portfolio envelope (via Uniblock's Hydromancer portfolioState, dex=ALL_DEXES). One call covers perp positions across native + every HIP-3 dex, spot balances, and the user's abstraction mode. Don't loop per-dex. Shape:

  {
    "clearinghouseState": {                 // perp side, across native + every HIP-3 dex
      "withdrawable": "...",                 // USDC available for native-dex perps + spot
      "marginSummary": { "accountValue", "totalMarginUsed", "totalNtlPos", "totalRawUsd" },
      "crossMarginSummary": { ... },
      "crossMaintenanceMarginUsed": "...",
      "assetPositions": [
        { "entryPx", "positionValue", "returnOnEquity", "unrealizedPnl",
          "liquidationPx", "leverage", "size", "coin", "dex" }
        // includes positions on native dex AND on HIP-3 dexes (xyz, flx, vntl, hyna, km, abcd, cash, para, …)
      ]
    },
    "spotClearinghouseState": {
      "balances": [{ "coin", "total", "hold", "entryNtl" }]   // USDC + all other spot tokens
    },
    "userAbstraction": "unifiedAccount" | "portfolioMargin" | "dexAbstraction" | "default" | "disabled"
  }
  

  withdrawable is at clearinghouseState.withdrawable (NOT nested in marginSummary). Pass dex=<name> only to scope to a single dex — the default ALL_DEXES already covers everything.

  Note: GET /agent/trading/account/spot is removed. The spot slice is in spotClearinghouseState of the same /account response.

• POST /agent/trading/batch-portfolio-states body {addresses: ["0x…", "0x…", …]} — Bulk variant of /account for many wallets in one call. Returns the same per-address envelope keyed by address. Use for leaderboard click-throughs and watchlists.

• GET /agent/trading/portfolio (?address=) — Time-series equity curve (different shape from /account: portfolio over time windows). Use for charts / historical PnL, not for current snapshot.

• GET /agent/trading/rate-limit (?address=) — API rate-limit status.

• GET /agent/trading/deposit-address — Address to send USDC to fund Hyperliquid. The address lives on Hyperliquid. HIP-4 outcomes settle in USDC too. Only HIP-3 dexes that use non-USDC collateral (e.g. USDH) need a different token that isn't deposit-fundable here — get it via a Hyperliquid spot swap (USDC → USDH).

• POST /agent/trading/withdraw body {amount} — Withdraw USDC to the same wallet's Arbitrum address. Flat $1 fee, ~5 min finalize. Destination is hardcoded to the signer; no third-party transfers. Bridge from Arbitrum onward via openfin-relay.

---

Market data (REST)

• GET /market/mids — All asset mid prices ({BTC:"70939.5",…}).
• GET /market/metas (?dex=) — Market metadata + asset contexts (funding, OI, mark/mid/oracle, 24h vol, premium, prev day).
• GET /market/perp-metas — Perp metadata across all perp DEXs. Each universe per DEX has name, szDecimals, maxLeverage, marginTableId, isDelisted. HIP-3 DEXs add tokenized equity perps (xyz:NVDA, xyz:TSLA, …). Use to compute the numeric a index
  • pull szDecimals before placing orders.
• GET /market/perp-categories — HIP-3 discovery. Returns [[symbol, category], …] where category ∈ crypto, stocks, commodities, indices, fx, preipo. Use for "list stock perps", "what FX HIP-3 perps exist", "show commodities", "preipo perps". To place an order, look the symbol up in /market/perp-metas for its asset index + szDecimals.
• GET /market/spot-metas (?dex=) — Spot universe (token pairs)
  • per-pair contexts.
• GET /market/l2-book/:coin — L2 orderbook (bids + asks at px/sz/n).
• GET /market/token/:tokenId — Spot token info. :tokenId is the full hex hash from spot-metas (e.g. 0xc1fb593aeffbeb02f85e0308e9956a90), NOT a number.
• GET /market/all-dexs-asset-ctxs — Asset contexts across every DEX (snapshot of the WS channel of the same name). The array has no asset names — entries map by index to the universe from /market/metas. Call /market/metas once to build the index→name map.

Historical OHLCV (direct to Hyperliquid)

POST https://api.hyperliquid.xyz/info
{ "type": "candleSnapshot",
  "req": { "coin": "BTC", "interval": "1h",
           "startTime": 1706659200000, "endTime": 1706745600000 } }

Intervals: 1m,3m,5m,15m,30m,1h,2h,4h,8h,12h,1d,3d,1w,1M. Up to 5000 candles. HIP-3 spot prefix the coin (xyz:XYZ100).

Market data (WebSocket)

wss://api.hyperliquid.xyz/ws. Subscribe with {method:"subscribe", subscription:{type:"<channel>"}}. Channels: allMids, allDexsAssetCtxs, l2Book ({type,coin}), trades ({type,coin}), candle ({type,coin,interval}), orderUpdates, userFills, userFundings.

The OpenFinance backend keeps one shared connection and caches per channel. MCP: subscribe_all_dexs_asset_ctxs, unsubscribe_all_dexs_asset_ctxs, get_all_dexs_asset_ctxs, get_ws_status. For per-client streams, open your own WS.

---

Orders

One-liner defaults (don't interrogate)

For "buy $10K of BTC" / "long ETH 5x" / "short SOL 1k":

• Direction — buy/long → buy; sell/short → sell. Bare "place" → long.
• Venue — perp unless user says "spot" or asset isn't a perp. Existing position in same coin → ambiguous = add to position.
• Leverage — use the asset's currently-set leverage; only change if user names a number ("5x", "10x").
• Order type — Ioc cross-book for "buy now" / no qualifier; Gtc resting limit only when user names a price; FrontendMarket for HIP-3 stock perps.
• Size — USD notional → base size via sz = usd / mid from /market/mids; round to szDecimals from /perp-metas.

Pre-flight (always)

Run the auto-unify rule, then:

required = (sz * px) / leverage     # perp / HIP-3
required = sz * px                  # spot buy

if unifiedFreeUSDC < required: walk the funding ladder

Spot sells: read the base token's total from /account/spot.

Funding ladder (when short)

1. Bridge from another chain. GET /agent/wallets; if any chain has USDC, bridge via openfin-relay into the Hyperliquid deposit address.
2. Onramp (if every wallet is empty). Show wallet addresses and suggest the user deposit, then bridge → trade.

Common failure mode: agent reads only account.withdrawable, sees $0, suggests onramp, never checks spot or other wallets — which often have the funds.

Place — POST /agent/trading/orders

Body uses Hyperliquid's single-letter field names. Human-readable ones (coin / is_buy / sz / limit_px / order_type / reduce_only) appear only in GET responses; the request side rejects them.

❌ Wrong — crashes with Cannot read properties of undefined (reading 'limit') because the validator reads order.t.limit.tif:

{ "orders": [{ "coin": "xyz:NVDA", "is_buy": false, "sz": 0.052,
               "limit_px": 384.96,
               "order_type": { "limit": { "tif": "FrontendMarket" } },
               "reduce_only": false }],
  "grouping": "na" }

✅ Right — same trade, correct shape:

{ "orders": [{ "a": 110012, "b": false, "p": "384.96", "s": "0.052",
               "r": false,
               "t": { "limit": { "tif": "FrontendMarket" } } }],
  "grouping": "na" }

Per-order fields:

• a — numeric asset index (formula below). Main-DEX BTC=0, ETH=1, …; HIP-3 e.g. xyz:NVDA = 110012. Never send a coin symbol.
• b — true = buy, false = sell.
• p — price; string is safest ("65000"). Always string for spot.
• s — size, string in base-asset units ("0.01"), pre-rounded to szDecimals (backend does NOT re-round size).
• r — bool, reduce-only.
• t — order type, exactly one branch:
  • { "limit": { "tif": "Gtc" | "Ioc" | "Alo" | "FrontendMarket" } }
  • { "trigger": { "isMarket": bool, "triggerPx": "string-or-number", "tpsl": "tp" | "sl" } } — for stop / take-profit.
• c — optional cloid (client order id) for idempotency.

Top-level grouping: "na" (default) | "normalTpsl" (group TP/SL with a primary order) | "positionTpsl" (attach TP/SL to existing position).

insufficientCollateral on rejections. When an order fails with "insufficient", the response carries insufficientCollateral: [{ requiredAsset, dex, context, message }]. The asset is NOT always USDC:

• Native perps → USDC
• HIP-4 outcomes → USDC
• HIP-3 perps → the dex's collateralToken (often USDC, sometimes USDH)

Relay requiredAsset + message to the user verbatim. The only non-USDC case is a HIP-3 dex on USDH — don't say "deposit USDC" when the backend asks for USDH; the user gets USDH by swapping USDC → USDH on Hyperliquid spot, not by depositing.

Asset index formula (HIP-3 included)

• Main-DEX perps: a = index_in_meta (BTC=0, ETH=1, …).
• HIP-3 perps: a = 100000 + perp_dex_index * 10000 + index_in_meta.
• Spot: a = 10000 + spotInfo.index.

Pull index_in_meta from /market/perp-metas per-DEX, perp_dex_index from the perpDexs info call. Example: xyz:NVDA on perp_dex_index=1, index_in_meta=12 → a = 110012. Reference: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids

HIP-3 perps (tokenized equities, etc.)

Same body as main DEX — same a/b/p/s/r/t fields. Only difference: a is a large offset index. The backend handles builder fee + signing internally; do not send a builder field. FrontendMarket is the typical TIF for stock perps.

HIP-4 outcomes (Yes/No binary outcomes on questions)

Hyperliquid's prediction-market-style surface. Each outcome has two sides — 0 = No, 1 = Yes. Outcomes are grouped under a question (with a fallback outcome plus named outcomes).

Collateral: USDC (same as native perps). split / merge / negate burn or mint USDC, and place_order on outcome share tokens debits / credits USDC too — no USDH, no spot swap. (This changed: HIP-4 previously required USDH; it no longer does.) On "insufficient" errors the response carries insufficientCollateral: { requiredAsset: "USDC", … }.

Asset-ID encoding — outcome tokens trade through the regular spot place_order / modify_order / cancel_order path. Encoding:

encoding   = 10 * outcome + side        # side ∈ {0, 1}
spot coin  = "#<encoding>"               # e.g. "#11" for outcome 1, Yes
token name = "+<encoding>"
asset id a = 100_000_000 + encoding      # 100000011 for outcome 1, Yes

Discovery + write actions:

• GET /market/outcome-meta (public) — Returns { outcomes: [{outcome, name, description, sideSpecs}], questions: [{question, name, description, fallbackOutcome, namedOutcomes, settledNamedOutcomes}] }.
• POST /outcome/split body {outcome, amount} — Burn amount quote tokens → mint amount Yes + amount No shares. amount is a decimal string ("123.0").
• POST /outcome/merge body {outcome, amount?} — Burn amount Yes + amount No → mint amount quote. amount: null = max (full pair-matched balance).
• POST /outcome/merge-question body {question, amount?} — Burn amount Yes shares from every named outcome of the question → mint amount quote. null = max.
• POST /outcome/negate body {question, outcome, amount} — Burn amount No shares of one outcome → mint amount Yes shares of every other outcome of the same question.

To trade an outcome token directly, derive a via the encoding above and use the regular place_order / cancel_order / modify_order flow with s as a decimal-string size.

Read

All four below accept ?address=0x… to read another wallet's data.

• GET /agent/trading/orders — Open orders (compact). coin, side (B/A), limitPx, sz, oid, timestamp, orderType.
• GET /agent/trading/orders/details — Full details: adds origSz, triggerPx, triggerCondition, cloid, reduceOnly.
• GET /agent/trading/orders/history — Filled / cancelled / rejected. Adds statusMsg, filledSz, avgFillPx, cloid.
• GET /agent/trading/orders/:oid/status — Single order status.

Cancel / modify

• DELETE /agent/trading/orders body {cancels: [{a, o}]} — a = numeric asset index, o = order ID. Batch-cancellable.
• PUT /agent/trading/orders/:oid body {order: {…}} — Modify; same order shape as place.

TWAP

• POST /agent/trading/twap — Place a TWAP that splits a large trade into market slices over a duration. Returns twapId.
• GET /agent/trading/twap/fills — Slice executions across all TWAPs. Returns fills with parent twapId.
• DELETE /agent/trading/twap/:twapId — Terminate; already-filled slices remain settled.

Leverage & margin

• POST /agent/trading/leverage body {asset, isCross, leverage} — Set leverage + margin mode. asset = numeric index (same a). isCross: true = shared cross pool, false = isolated per-position. Symbol like "xyz:NVDA" returns Failed to update leverage — must be numeric.
• POST /agent/trading/margin body {asset, isBuy, ntli} — Add (ntli > 0, lowers liquidation risk) or remove margin from an isolated-margin position. Cross-margin positions don't accept this.

Fills & funding

• GET /fills (?aggregateByTime=) — Latest fills. coin, side, px, sz, feeUsdc, oid, cloid, crossed, liquidation.
• GET /fills/by-time (?startTime&endTime) — Same, time-windowed (ms).
• GET /funding — Perp funding payment history. usdc > 0 = received, < 0 = paid.

---

Sizing gotchas

• s is base-asset (BTC, ETH), not USD. BTC at $65k, s="0.01" = $650 notional.
• Tick size differs per asset — round p per-asset using szDecimals from perp-metas.
• Hyperliquid rejects prices outside the band (~5–10% from mid). For aggressive fills, cross the book but stay in-band.

---

Don't

• Don't use Gtc for "buy now" — use Ioc cross-book.
• Don't put USD amounts in s — base-asset only.
• Don't trust account.withdrawable alone for free USDC — sum with spot.USDC.total.
• Don't reason about "perp USDC" vs "spot USDC" as separate balances, and don't surface the split in user replies (see Reply format).
• Don't suggest onramp before reading the unified balance + checking other wallets.
• Don't send a coin symbol as a (or as asset on /leverage, /margin, cancel) — must be the numeric index.

---

MCP

Hyperliquid is a single dispatch tool: hyperliquid with an action enum — get_all_mids, get_market_metas, get_perp_categories, get_l2_book, get_token_details, get_candle_snapshot, get_deposit_address, get_account_summary, get_batch_portfolio_states, get_rate_limit, get_open_orders, get_historical_orders, get_order_status, place_order, cancel_order, modify_order, place_twap_order, get_twap_fills, terminate_twap_order, get_user_fills, get_user_funding_history, update_leverage, update_isolated_margin, withdraw_to_arbitrum, get_user_abstraction, set_user_abstraction, set_all_dexs_asset_ctxs_subscription, get_all_dexs_asset_ctxs, get_ws_status, plus HIP-4: get_outcome_meta, split_outcome, merge_outcome, merge_question, negate_outcome.

Every user-scoped read action above accepts an optional address parameter (the MCP-layer equivalent of the REST ?address= query) — falls back to the caller's wallet. get_deposit_address is deliberately caller-only.