Grimoire Hyperliquid

by franalgaba2cca3994a288No license6 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 5 months ago

Queries Hyperliquid market data using the Grimoire venue CLI. Use when you need mids, books, metadata, open orders, or a withdrawal call.

Instructions onlyBusiness & Finance
AI-generated overview

Queries Hyperliquid market data through the Grimoire venue CLI, including mids, order books, metadata and open orders.

What it does
This skill documents how to call the Grimoire venue CLI for Hyperliquid, covering read-only market data such as mid prices, L2 order books, open orders, perp metadata and spot metadata. It also describes snapshot variants that emit spell params blocks, spell order actions, a mid_price metric, and a stateful withdrawal command. It produces command invocations and spell snippets rather than files.
When to use it
Use it when you need Hyperliquid market data, metadata snapshots, or spell inputs for Hyperliquid. It also applies when an explicitly requested withdrawal or order placement on Hyperliquid is required.
Requirements
Requires the Grimoire venue CLI (grimoire, npx @grimoirelabs/cli, or the grimoire-hyperliquid binary) and network access to Hyperliquid. Stateful actions need HYPERLIQUID_PRIVATE_KEY or keystore credentials plus explicit user confirmation. No scripts ship with the skill.

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 tablegrimoire venue hyperliquid mids --format spellgrimoire venue hyperliquid l2-book --coin BTCgrimoire venue hyperliquid l2-book --coin BTC --format spellgrimoire venue hyperliquid open-orders --user 0x0000000000000000000000000000000000000000grimoire venue hyperliquid metagrimoire venue hyperliquid mids-snapshotgrimoire venue hyperliquid l2-book-snapshot --coin BTCgrimoire 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.

Source and attribution

Source:franalgaba/grimoireinskills/grimoire-hyperliquidat commit2cca399

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal