Summary

FinMind provides an extensive collection of over 50 open-source financial datasets, primarily focused on Taiwanese stocks but also including international market data. It aims to empower researchers, developers, and financial analysts by offering daily updated data, thereby eliminating the need for manual data collection and aggregation.

How It Works

The project aggregates diverse financial information, including technical indicators (daily prices, real-time quotes, historical ticks, PER, PBR), fundamental data (income statements, cash flow, balance sheets, dividends, revenue), market sentiment (institutional holdings, stock distribution, margin trading, short selling), news, and derivatives data (futures, options). It also covers US stock prices, bond yields, and commodity prices. Data is automatically updated daily and accessible via a Python package and an API, simplifying data-driven financial analysis.

Quick Start & Requirements

• Install: pip install FinMind
• Prerequisites: Python.
• Documentation: Official Documentation is available.
• Examples: The README provides code snippets for downloading various data types (e.g., taiwan_stock_daily, add_kline_institutional_investors) and plotting k-line charts.

Highlighted Details

• Comprehensive coverage of over 50 financial datasets, including Taiwanese stocks, US stocks, futures, options, and international market indicators.
• Automatic daily data updates ensure data freshness.
• Includes llms.txt and llms-full.txt files to facilitate AI model integration for understanding datasets and API usage.
• API request limits apply: 300 requests/hour, extendable to 600 requests/hour upon registration and email verification on the official website.

Maintenance & Community

• Contact: FinMind.TW@gmail.com
• Maintenance Window: Weekly, Sundays from 00:00 to 07:00 UTC, during which service is unavailable.
• Future Plans: Development includes personalized backtesting analysis and chatbot strategy monitoring.

Licensing & Compatibility

• License: Content is provided for educational, non-commercial use only.
• Disclaimer: Data is for reference; users are solely responsible for trading losses. The project disclaims responsibility for data errors, delays, or interruptions.
• Compatibility: Strictly limited to non-commercial applications due to licensing terms.

Limitations & Caveats

The non-commercial use restriction significantly limits adoption for business or production environments. API usage is rate-limited, requiring registration for higher limits. A weekly maintenance window impacts data availability. Users bear full responsibility for any trading outcomes based on the provided data.