Skip to content

dethan3/tickeye

Repository files navigation

🦉 TickEye

TickEye is a lightweight, no-frontend fund monitoring tool that tracks your purchased funds and provides daily performance analysis using AkShare API.

中文版 README

📌 Features

  • Fund & Index Tracking: Monitor your funds and major indices (global and China)
  • Real-time Indices: Global indices via index_global_spot_em; China indices via stock_zh_index_spot_em (default to same-day spot, fallback to daily history)
  • Flexible Configuration: Configure items in funds_config.json (supports funds and indices)
  • Smart Name Resolution: Automatically fetch fund names via API when not provided
  • Performance Analysis: Daily net value and percentage change tracking
  • Multi-item Support: Monitor multiple funds/indices simultaneously
  • Clean Output: Beautiful console output with trend indicators (📈📉➡️)

⚙️ Tech Stack

Component Tech / Tool
Language Python 3.8+
Data Source AkShare API
Data Processing pandas
HTTP Client requests
Config Parsing JSON file parsing

🚀 Quick Start

Prerequisites

  • Python 3.8 or higher
  • Internet connection for API access

1. Clone the Repository

git clone https://github.com/yourusername/tickeye.git
cd tickeye

2. Create Virtual Environment (Recommended)

python -m venv tickeye_env
source tickeye_env/bin/activate  # On Windows: tickeye_env\Scripts\activate

3. Install Dependencies

pip install -r requirements.txt

4. Configure Your Items

Use funds_config.json to configure funds and indices:

{
  "items": [
    {"code": "007360", "name": "易方达中短期美元债A"},
    {"code": "001917", "name": "招商量化精选股票A"},

    {"code": "000001", "name": ""},           
    {"code": "HSI", "name": "恒生指数"},      
    {"code": "NDX", "name": "纳斯达克"},      
    {"code": "SPX", "name": "标普500"}
  ]
}

Notes:

  • For funds, use the 6-digit code (e.g., 001917).
  • For China indices, you can use alias 000001 (mapped to sh000001 internally) or direct symbol sh000001/sz399001.
  • For global indices, use tickers like HSI, NDX, SPX, VNINDEX, etc.
  • name is optional; when empty, the tool will resolve via API/config.
  • Optional: you can add/adjust index aliases in indices_config.json.

5. Run Fund/Index Analysis

# Monitor for 1 day (default); indices default to same-day spot
python fund_analysis.py

# Request multiple days of history (funds use history; indices still prefer spot by default)
python fund_analysis.py 7

6. Understanding the Output

The tool provides a comprehensive report with:

  • Code & Name: Funds and indices; names auto-resolved
  • Latest Date: Most recent trading date or current timestamp for spot indices
  • Net Value / Spot: Unit NAV (fund) or index level
  • Change %: Daily percentage change (spot for indices; close-to-close for history)
  • Trend: Visual indicators (📈 up, 📉 down, ➡️ flat)
  • Summary: Overall statistics and success rate

7. Configuration Tips

  • Smart Name Resolution: The tool prioritizes API-fetched names over config file names for accuracy
  • Error Handling: Invalid fund codes are automatically skipped with error messages
  • Flexible Format: Mix both code|name and code formats in the same config file
  • Comments: Use # for comments and documentation in your config file

📄 License

MIT License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •