Skip to content

docs(readme): add bulk historical data source (Parquet) to Usage Guide #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshavenue wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(readme): add bulk historical data source (Parquet) to Usage Guide #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca8c6a5
docs(readme): add Reservoir as a bulk historical data source
joshavenue Oct 20, 2026
ba60ace
docs: point Reservoir link to overview post
joshavenue Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,12 @@ let candles = info_client
// Supported coins: BTC, ETH, SOL, AVAX, MATIC, ATOM, and many more
```

### Bulk Historical Data (Alternative Source)

The examples above pull candles from the Hyperliquid info API. If you need longer or more granular history for backtests, such as trade-level fills or order book state, pre-built Parquet datasets are another option:

- **[Hydromancer Reservoir](https://hydromancer.xyz/hyperliquid-historical-data)**: Hyperliquid historical data on AWS S3 (`s3://hydromancer-reservoir`, region `ap-northeast-1`, requester pays), stored as Parquet and partitioned by `date=YYYY-MM-DD`. It includes trade fills (with liquidation, ADL and TWAP subsets), 1-second OHLCV candles, 20-level order book snapshots at 1-minute cadence, and daily position snapshots, for Hyperliquid perps and HIP-3 dexes. Any Parquet reader (DuckDB, Polars, or the `arrow`/`parquet` crates) can load it into the OHLC vectors used in the backtesting example above. It does not include funding rates, so keep using the API for those.

### Trading Modes

The library supports multiple trading modes through the unified interface:
Expand Down Expand Up @@ -574,4 +580,4 @@ This software is for educational and research purposes only. Trading cryptocurre

- **Issues**: [GitHub Issues](https://github.com/xsa-dev/hyperliquid-backtest/issues)
- **Discussions**: [GitHub Discussions](https://github.com/xsa-dev/hyperliquid-backtest/discussions)
- **Documentation**: [docs.rs](https://docs.rs/hyperliquid-backtest)
- **Documentation**: [docs.rs](https://docs.rs/hyperliquid-backtest)