/hyperliquid-reader

name: hyperliquid-reader
description: >
  Read Hyperliquid (app.hyperliquid.xyz) perp + spot market data via
  opencli (read-only, public info API). Use whenever the user wants
  Hyperliquid perpetual or spot markets, mark/oracle/mid prices, 24h
  change, funding rates (hourly or annualized APR), open interest, volume,
  the L2 order book, OHLCV candles, historical funding, or a cross-venue
  funding comparison (Hyperliquid vs Binance vs Bybit) for funding
  arbitrage. Triggers: "Hyperliquid funding for BTC", "HL perp markets",
  "funding on BTC perp", "Hyperliquid order book", "HL open interest",
  "funding arb Hyperliquid vs Binance", "Hyperliquid candles for SOL",
  "Hyperliquid spot markets", "PURR price on Hyperliquid", "hyperliquid",
  "hyperliquid.xyz", "HL DEX". READ-ONLY market data — no account, order,
  or trade operations.

Hyperliquid Reader (Read-Only)

Reads [Hyperliquid](https://app.hyperliquid.xyz) — the on-chain perps/spot DEX — for market data via [opencli](https://github.com/jackwener/opencli) and the `hyperliquid` plugin in this repo's [`opencli-plugins/hyperliquid`](https://github.com/himself65/finance-skills/tree/main/opencli-plugins/hyperliquid) tree (a separate plugin from opencli's built-in adapters, installed via opencli's monorepo subpath syntax).

**This skill is read-only and market-data only.** It reads Hyperliquid's fully public info API for analysis: market tables, funding, order book, and candles. It does NOT read individual accounts, place/modify/cancel orders, or move funds. There is no trading path in the plugin — order placement requires wallet-signed actions on a separate endpoint this adapter never calls.

**How it works**: every command issues a single `POST https://api.hyperliquid.xyz/info` with a `{ "type": "..." }` body and normalizes the response. **No API key, no wallet, no login, no running app** — the info API is public.

---

Step 1: Ensure opencli + Plugin Are Installed and Ready

**Current environment status:**

!`(command -v opencli && opencli hyperliquid markets --coin BTC -f json 2>&1 | head -3 && echo "READY" || echo "SETUP_NEEDED") 2>/dev/null || echo "NOT_INSTALLED"`

If the status above shows `READY`, skip to Step 2. Otherwise:

NOT_INSTALLED — Install opencli

npm install -g @jackwener/opencli

Requires Node.js >= 24 — the `hyperliquid` plugin declares `engines.node >= 24`.

SETUP_NEEDED — Install the Hyperliquid plugin

The Hyperliquid adapter is **not** built into opencli — it's a separate plugin:

opencli plugin install github:himself65/finance-skills/hyperliquid

That's the entire setup — no auth, no launch step. Verify with `opencli hyperliquid markets --coin BTC`.

Common setup issues

| Symptom | Fix | |---|---| | `opencli: command not found` | `npm install -g @jackwener/opencli` (Node ≥ 24) | | `Unknown command: hyperliquid` | `opencli plugin install github:himself65/finance-skills/hyperliquid` | | `hyperliquid info 429` | Rate limited — wait a few seconds and retry |

---

Step 2: Identify What the User Needs

| User Request | Command | Key Flags | |---|---|---| | Perp markets overview / top by volume | `opencli hyperliquid markets` | `--sort`, `--limit`, `--coin` | | One perp's price + funding + OI | `opencli hyperliquid markets --coin BTC` | — | | Spot pairs overview | `opencli hyperliquid spot-markets` | `--sort`, `--limit`, `--pair`, `--canonical-only` | | All current mid prices | `opencli hyperliquid mids` | `--coin <substring>` | | Order book for a coin | `opencli hyperliquid book --coin ETH` | `--depth`, `--n-sig-figs` | | OHLCV candles | `opencli hyperliquid candles --coin BTC --interval 1h` | `--limit` | | Historical funding for a coin | `opencli hyperliquid funding-history --coin BTC` | `--hours`, `--limit` | | Funding arb: HL vs Binance vs Bybit | `opencli hyperliquid funding-compare` | `--coin`, `--sort`, `--limit` |

---

Step 3: Execute the Command

General pattern

# Use -f json or -f yaml for structured output
opencli hyperliquid markets --sort fundingAprPct --limit 15 -f json
opencli hyperliquid funding-compare --sort hlVsBinancePct --limit 20 -f md
opencli hyperliquid candles --coin BTC --interval 4h --limit 50 -f csv
opencli hyperliquid book --coin ETH --depth 5 -f json

Key rules

1. **Coin symbols are bare perp names** — `BTC`, `ETH`, `SOL`, `HYPE` (no exchange prefix). Spot pairs are `BASE/USDC` (e.g. `PURR/USDC`); for `book`/`candles` you can pass either a perp coin or a spot pair. 2. **`markets` is the default lens for "how is X / the market doing"** — it carries mark/oracle/mid price, 24h change, hourly funding + APR, open interest (coins and notional), and 24h volume in one row per perp. Filter with `--coin` for a single asset. 3. **Funding is reported two ways** — `fundingHrPct` is the raw hourly rate as a percent; `fundingAprPct` annualizes it (`hourly × 24 × 365`). Lead with APR when comparing carry across assets; use the hourly figure for "what will I pay next hour". 4. **`funding-compare` is the funding-arb screen** — it annualizes each venue with its own interval (HL hourly, Binance/Bybit usually 4h) and reports `hlVsBinancePct` / `hlVsBybitPct` spreads. Default sort ranks by **absolute** HL-vs-Binance spread (widest dislocations first). A positive `hlVsBinancePct` means HL longs pay more than Binance longs. 5. **`book` defaults to 10 levels per side** — raise `--depth` (max 20) for more, or `--n-sig-figs 2..5` to aggregate price levels. Compute the spread/mid from the top bid and ask. 6. **`candles` pulls the most recent `--limit` candles** of `--interval` (default `1h`, 100 candles). Valid intervals: `1m 3m 5m 15m 30m 1h 2h 4h 8h 12h 1d 3d 1w 1M`. Max 5000. 7. **`-f json`** for programmatic processing / feeding other skills; `-f md` or `-f table` for human-readable output. 8. **NEVER call any write operation.** This skill is read-only market data — no account reads, no order placement, modification, or can