Grimoire Hyperliquid
Pull Hyperliquid perp mids, L2 books, metadata, and optional open-order snapshots through the Grimoire venue CLI inside your coding agent.
Overview
Grimoire Hyperliquid is an agent skill for the Build phase that queries Hyperliquid market data and optional withdrawals through the Grimoire venue CLI.
Install
npx skills add https://github.com/franalgaba/grimoire --skill grimoire-hyperliquidWhat is this skill?
- Read-only commands: mids, l2-book, open-orders, meta, and spot-meta via `grimoire venue hyperliquid`
- Snapshot variants emit agent-oriented spell `params:` blocks with `--format spell`
- Preflight with `grimoire venue doctor --adapter hyperliquid --json` before trading workflows
- Supports npx no-install, bun repo-local, and direct `grimoire-hyperliquid` binary invocations
- Stateful `withdraw` only when explicitly requested and `HYPERLIQUID_PRIVATE_KEY` is set
Adoption & trust: 1.1k installs on skills.sh; 5 GitHub stars; 1/3 security scanners passed (skills.sh audits).
What problem does it solve?
You need trustworthy Hyperliquid mids, books, and metadata inside an agent session without hand-rolling HTTP clients and response parsers each time.
Who is it for?
Indie builders wiring Hyperliquid reads into agent tooling or CLI automation with Grimoire already on the path.
Skip if: Builders who only need static DeFi docs without live venue calls, or anyone unwilling to handle private keys for withdrawal flows.
When should I use this skill?
You need Hyperliquid mids, books, metadata, open orders, or an explicit withdrawal call via Grimoire.
What do I get? / Deliverables
You get copy-paste CLI invocations and snapshot params blocks you can chain into spells, bots, or local analytics scripts.
- CLI command recipes for mids, books, and meta
- Spell-formatted snapshot params blocks
- Doctor preflight checklist output
Recommended Skills
Journey fit
Build is where you wire external market and trading venues into agents, dashboards, or automation—not where you run growth or launch distribution. Integrations captures CLI-backed venue adapters, env-keyed stateful calls, and spell-ready snapshot params for downstream agent steps.
How it compares
Venue CLI integration skill, not a hosted MCP market-data server.
Common Questions / FAQ
Who is grimoire-hyperliquid for?
Solo developers and agent authors who trade or monitor Hyperliquid perps and want Grimoire-standard CLI commands inside their coding workflow.
When should I use grimoire-hyperliquid?
During Build integrations when fetching mids, L2 books, open orders, or meta snapshots—or when you explicitly need a scripted withdrawal with keys configured.
Is grimoire-hyperliquid safe to install?
Withdrawals require a private key and real funds risk; review the Security Audits panel on this Prism page and never commit `HYPERLIQUID_PRIVATE_KEY` to git.
SKILL.md
READMESKILL.md - Grimoire Hyperliquid
# Grimoire Hyperliquid Skill Use this skill for Hyperliquid metadata snapshots and, when explicitly requested, withdrawals. Preferred invocations: - `grimoire venue hyperliquid ...` - `npx -y @grimoirelabs/cli venue hyperliquid ...` (no-install) - `bun run packages/cli/src/index.ts venue hyperliquid ...` (repo-local) - `grimoire-hyperliquid ...` (direct binary from `@grimoirelabs/venues`) Recommended preflight: - `grimoire venue doctor --adapter hyperliquid --json` - Ensure `HYPERLIQUID_PRIVATE_KEY` is set before stateful actions (`withdraw`). Use `--format spell` for snapshot `params:` blocks. ## Commands Read-only data: - `grimoire venue hyperliquid mids` — mid prices for all perp assets - `grimoire venue hyperliquid l2-book --coin <symbol>` — L2 order book for a coin - `grimoire venue hyperliquid open-orders --user <address>` — open orders for an address - `grimoire venue hyperliquid meta` — perp market metadata (universe, margin tables) - `grimoire venue hyperliquid spot-meta` — spot market metadata (tokens, universe) Snapshot commands (agent-only, generate spell `params:` blocks): - `grimoire venue hyperliquid mids-snapshot` - `grimoire venue hyperliquid l2-book-snapshot --coin <symbol>` - `grimoire venue hyperliquid open-orders-snapshot --user <address>` - `grimoire venue hyperliquid meta-snapshot` - `grimoire venue hyperliquid spot-meta-snapshot` Stateful: - `grimoire venue hyperliquid withdraw --amount <usdc> --keystore <path> [--password-env <name>] [--destination <addr>]` ## Examples ```bash grimoire venue hyperliquid mids --format table grimoire venue hyperliquid mids --format spell grimoire venue hyperliquid l2-book --coin BTC grimoire venue hyperliquid l2-book --coin BTC --format spell grimoire venue hyperliquid open-orders --user 0x0000000000000000000000000000000000000000 grimoire venue hyperliquid meta grimoire venue hyperliquid mids-snapshot grimoire venue hyperliquid l2-book-snapshot --coin BTC grimoire venue hyperliquid meta-snapshot ``` Use `-snapshot` variants to emit `params:` blocks for spell inputs. These are agent-only (output suppressed in interactive mode). ## Spell Actions Hyperliquid uses `custom` action type with `op: "order"` for order placement: ```spell hyperliquid.custom(op="order", coin="ETH", price="3500", size="0.1", side="buy", order_type="Gtc") ``` The adapter does not support runtime constraints (`max_slippage`, etc.). Order parameters are validated at the adapter boundary. Supported TIF values: `Gtc`, `Ioc`, `Alo`, `FrontendMarket`. ## Metric Surface (Spell Comparisons) Hyperliquid exposes `mid_price` for symbol midpoint comparisons: ```spell hl_mid = metric("mid_price", hyperliquid, ETH) ``` The third argument is the Hyperliquid symbol to read (for example `ETH`, `BTC`, `SOL`). ## Notes - `withdraw` is stateful and requires explicit user confirmation plus keystore credentials. - `mids`, `l2-book`, `open-orders`, `meta`, `spot-meta` are read-only info calls. - Use `--format spell` for snapshot-based spell inputs. - Use `--format json` for `meta`/`spot-meta` in automation; `--format table` shows compact summaries for nested payloads. - `anvil`/`cast` are EVM tools and are not applicable for Hyperliquid execution/diagnostics.