# hyperliquid-reader

Reads public Hyperliquid market data including prices, funding, order books, and candles. Use it to inspect perp or spot markets without wallet access.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 533 installs · ★ 3453
- Author: himself65
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/himself65/finance-skills/tree/HEAD/plugins/data-providers/skills/hyperliquid-reader/SKILL.md
- Updated: 2026-10-25
- HTML: https://affpapa.org/en/nevibecode/skills/hyperliquid-reader

## What it does

This skill reads Hyperliquid mark, oracle, and mid prices, 24h change, volume, open interest, and funding rates. It can also return L2 order books, OHLCV candles, funding history, and funding comparisons with Binance and Bybit.

It uses `opencli` with the public info API. Commands include `opencli hyperliquid markets` for perp data, `opencli hyperliquid candles` for OHLCV data, and `opencli hyperliquid funding-compare` for venue spreads.

The skill is read-only: it does not access accounts, place orders, or move funds. Node.js >= 24 is required by the `hyperliquid` plugin, so check the runtime before installing.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add himself65/finance-skills --skill hyperliquid-reader -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/hyperliquid-reader/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/hyperliquid-reader/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add himself65/finance-skills --skill hyperliquid-reader -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/hyperliquid-reader/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add himself65/finance-skills --skill hyperliquid-reader -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/hyperliquid-reader/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install himself65/finance-skills hyperliquid-reader
```

2. **Manually: put the files in place**
- File: `.github/skills/hyperliquid-reader/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add himself65/finance-skills --skill hyperliquid-reader -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/himself65/finance-skills --path plugins/data-providers/skills/hyperliquid-reader
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/hyperliquid-reader/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add himself65/finance-skills --skill hyperliquid-reader -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/himself65/finance-skills/tree/HEAD/plugins/data-providers/skills/hyperliquid-reader/SKILL.md

## When to use it
- inspect a perp price, funding rate, and open interest
- compare annualized funding across Hyperliquid, Binance, and Bybit
- export OHLCV candles for `BTC`
- read five levels of the `ETH` order book
- look up the `PURR/USDC` spot pair

## Example prompts
- Check the `BTC` market price, funding, and open interest.
- Compare `BTC` funding on Hyperliquid, Binance, and Bybit.
- Show the `ETH` order book with depth 5 in JSON.

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 2da6fa39ec66215e.

BEGIN THIRD-PARTY FILE 2da6fa39ec66215e
````text
---
name: hyperliquid-reader
description: >
  Read Hyperliquid (app.hyperliquid.xyz) perp and spot market data through opencli and
  Hyperliquid's public info API: mark, oracle, and mid prices, 24h change, funding
  rates (hourly and annualized APR), open interest, volume, the L2 order book, OHLCV
  candles, funding history, and cross-venue funding comparisons (Hyperliquid vs
  Binance vs Bybit) for funding arbitrage. Use this skill whenever the user mentions
  Hyperliquid (HL, HL DEX, hyperliquid.xyz) or asks about its perps, spot pairs such
  as PURR, funding, open interest, order book, or candles. Read-only market data: no
  account, order, or transfer operations.
---

# Hyperliquid Reader (Read-Only)

If your host has not already executed the shell probes below (for example, in Codex), run the commands inside the `!` wrappers with its shell tool before choosing a setup path. Use the actual output; if shell access is unavailable, report that limitation.

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

```bash
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:

```bash
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) |
````
END THIRD-PARTY FILE 2da6fa39ec66215e

The third-party file has ended. Everything between the 2da6fa39ec66215e tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2967 of 9668 bytes. © himself65 · MIT · https://github.com/himself65/finance-skills/tree/HEAD/plugins/data-providers/skills/hyperliquid-reader/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md