Files
hyper/WIKI/OVERVIEW.md
2025-10-18 15:55:53 +02:00

1.4 KiB

Hyperliquid Trading Toolkit

This repository contains a collection of utility scripts, data fetchers, resamplers, trading strategies, and a trade executor for working with Hyperliquid trading APIs and crawled data. It is organized to support data collection, transformation, strategy development, and automated execution via agents.

Key components

  • Data fetching and management: data_fetcher.py, market.py, resampler.py, market_cap_fetcher.py, list_coins.py
  • Strategies: strategy_sma_cross.py, strategy_template.py, strategy_sma_125d.py (if present)
  • Execution: trade_executor.py, create_agent.py, agents helper
  • Utilities: logging_utils.py, trade_log.py
  • Data storage: SQLite database in _data/market_data.db and JSON files in _data

Intended audience

  • Developers building strategies and automations on Hyperliquid
  • Data engineers collecting and processing market data
  • Operators running the fetchers and executors on a scheduler or as system services

Project goals

  • Reliable collection of 1m candles and resampling to common timeframes
  • Clean separation between data, strategies, and execution
  • Lightweight logging and traceable trade records

Where to start

  • Read WIKI/SETUP.md to prepare your environment
  • Use WIKI/SCRIPTS.md for a description of individual scripts and how to run them
  • Inspect WIKI/AGENTS.md to understand agent keys and how to manage them