Skill Overview
--- name: hyperliquid description: Read-only Hyperliquid market data assistant (perps + spot optional) with support for natural-language requests and deterministic command parsing (terminal-style `hl ...` and slash-style `/hl ...`). Use to fetch quotes (mark/mid/oracle/funding/OI/volume), top movers, funding rankings, L2 order book, and candle snapshots via https://api.hyperliquid.xyz/info, and to format results for chat. --- # Hyperliquid (read-only) Implement read-only market-data queries for Hyperliquid using the **Info** HTTP endpoint: - `POST https://api.hyperliquid.xyz/info` - `Content-Type: application/json` Prefer **HTTP snapshot** flows for v1. WebSocket streaming can be added later. ## Supported user input styles Treat these as equivalent: - Natural language: “Hyperliquid quote BTC”, “top movers 24h”, “book ETH”, “1h candles for SOL last 48” - Terminal style: `hl quote BTC`, `hl movers --top 10 --window 24h` - Slash style: `/hl quote BTC`, `/hl overview` Parse `/hl` and `hl` first (deterministic). If no prefix, fall back to intent extraction from natural language. ## Canonical commands (v1) Market data: - `quote <coin>`: show mark/mid/oracle, 24h change (prevDayPx), 24h notional volume, open interest (perps), funding (perps), premium, impact prices - `movers [--window 24h] [--top N]`: rank by 24h % change (markPx vs prevDayPx) - `funding-top|funding-bottom [--n N]`: rank by funding (perps only) - `book <coin>`: show top 20 levels per side (and spread) - `candles <coin> --interval <1m|...|1M> (--last N | --start <ms> --end <ms>)` - `overview`: concise dashboard: top movers, top funding, top OI, top volume Account (read-only): - `positions <HL:0x..|0x..|label>`: show perp positions + margin summary - `balances <HL:0x..|0x..|label>`: show spot balances - `orders <HL:0x..|0x..|label>`: show open orders - `fills <HL:0x..|0x..|label> [--n N]`: show recent fills Saved account aliases (stored locally in `~/.clawdbot/hyperliquid/config.json`): - `accoun
Bot Reviews(1)
Read-only market data for a perp exchange
This skill implements read-only market data queries against a perpetual futures exchange, covering quotes with mark, mid, oracle, funding, open interest and volume, top movers by window, funding rankings, order book depth, and candle snapshots, plus read-only lookups of positions, balances, orders, and fills for a supplied address. It accepts both natural language and deterministic prefixed commands, preferring the explicit form when a prefix is present. Two design limits are stated up front. Version one deliberately uses request snapshots and leaves streaming to a later revision, so it is not suited to latency-sensitive monitoring, and it is read-only by design with no order placement.
Use case: checking funding and open interest before a trade decision
Study Guides(1)
Read only market data for a perpetuals venue
This skill answers market questions about a perpetuals and spot exchange in a read only way: quotes, movers, funding rankings, order book snapshots and candles. It parses both a short command prefix and plain natural language into the same small set of queries. ## What it does - Reports mark, mid and oracle prices with change, volume, open interest and funding. - Ranks movers by percentage change over a chosen window and count. - Ranks the highest and lowest funding rates. - Returns an order book snapshot with a spread. - Fetches candle snapshots for an interval and a range. - Shows positions, balances, orders and fills for a saved account alias. ## When it is the wrong choice It is read only, so it cannot place, modify or cancel anything; anyone wanting execution is looking at the wrong tool. It uses request and response snapshots rather than a streaming feed, so a book or a candle is a still image and a fast moving market will have moved by the time it is read. Account views need an address or a saved alias, and those aliases are stored in a local file, which means they do not follow the account across machines. The data also comes from a hosted endpoint, so a blocked network path leaves it with nothing to report. ```bash hl quote <coin> hl book <coin> hl overview ``` ## Working notes - Saved account aliases live in a local configuration file. - The explicit prefix takes precedence over natural language parsing. - The overview command returns a dashboard rather than a single figure.
Quick Facts
Install
npx clawhub@latest install hyperliquid