hl-research#
Python CLI and library for quantitative research on Hyperliquid. Pulls historical data from the HL info API on demand, caches locally as Parquet, and provides primitives for backtesting, wallet behavior analysis, vault inspection, and funding research. Runs from a laptop, no infrastructure required.
Install#
Python 3.12 or newer.
First commands#
hlr data pull BTC --since 2024-01-01
hlr wallet wrapped 0xabc... --out wrapped.html
hlr backtest run my_strategy.py --asset BTC
hlr funding heatmap
hlr tui
See Quickstart for the guided tour.
Command surface#
| Group | Pages |
|---|---|
| Data | data |
| Wallet | wallet |
| Funding | funding |
| Vault | vault |
| Backtest | backtest |
| TUI | tui |
Reference#
- Architecture — module layout and data flow
- Writing a strategy — the Strategy base class and event hooks
- Cache layout — how data lives on disk
Status#
v0.1.0 is the first public release. The wallet wrapped HTML report is the headline artifact. Stability guarantees come at v1.0.0; until then, expect minor breaks at minor versions.