# FinMind

> FinMind is an open-source financial data platform providing 75+ Taiwan market datasets and international market data (US, UK, Europe, Japan) via REST API and Python SDK. Data is updated daily. Datasets cover technical analysis, fundamentals, institutional trading, derivatives, convertible bonds, real-time quotes, exchange rates, interest rates, commodities, and US government bond yields.

## API Overview

- Base URL: `https://api.finmindtrade.com/api/v4`
- Authentication: Register at finmindtrade.com, get token via login API or website. Pass token as `Authorization: Bearer {token}` header or `token` query parameter.
- Rate limit: 600 requests/hour (with token), 300/hour (without token).
- Four endpoints:
  - `POST /login` - Get auth token (params: user_id, password)
  - `GET /data` - Fetch dataset (params: dataset, data_id, start_date, end_date, token)
  - `GET /datalist` - List available data_id values for a dataset
  - `GET /translation` - Get English-Chinese column name mapping for a dataset

## Python SDK

```python
from FinMind.data import DataLoader
api = DataLoader()
api.login_by_token(api_token='your_token')
df = api.taiwan_stock_daily(stock_id='2330', start_date='2020-01-01')
```

## Documentation

- [Quick Start](https://finmind.github.io/quickstart/): API usage guide with examples in Python and R
- [Login](https://finmind.github.io/login/): Authentication methods
- [API Usage Count](https://finmind.github.io/api_usage_count/): Check API usage limits

### Taiwan Market (75 datasets)

- [Taiwan DataList](https://finmind.github.io/tutor/TaiwanMarket/DataList/): Full list of 75 Taiwan datasets
- [Technical](https://finmind.github.io/tutor/TaiwanMarket/Technical/): TaiwanStockInfo, TaiwanStockPrice, TaiwanStockPriceAdj, TaiwanStockPriceTick, TaiwanStockPER, TaiwanStockKBar, TaiwanStockWeekPrice, TaiwanStockMonthPrice, TaiwanStockDayTrading, TaiwanStockTotalReturnIndex, TaiwanVariousIndicators5Seconds, TaiwanStockTradingDate, etc.
- [Chip (Institutional)](https://finmind.github.io/tutor/TaiwanMarket/Chip/): TaiwanStockMarginPurchaseShortSale, TaiwanStockInstitutionalInvestorsBuySell, TaiwanStockShareholding, TaiwanStockHoldingSharesPer, TaiwanStockSecuritiesLending, TaiwanStockTradingDailyReport, TaiwanstockGovernmentBankBuySell, etc.
- [Fundamental](https://finmind.github.io/tutor/TaiwanMarket/Fundamental/): TaiwanStockCashFlowsStatement, TaiwanStockFinancialStatements, TaiwanStockBalanceSheet, TaiwanStockDividend, TaiwanStockDividendResult, TaiwanStockMonthRevenue, TaiwanStockMarketValue, etc.
- [Derivative](https://finmind.github.io/tutor/TaiwanMarket/Derivative/): TaiwanFuturesDaily, TaiwanOptionDaily, TaiwanFuturesTick, TaiwanOptionTIck, TaiwanFuturesInstitutionalInvestors, TaiwanOptionInstitutionalInvestors, TaiwanFuturesDealerTradingVolumeDaily, TaiwanOptionDealerTradingVolumeDaily, TaiwanFuturesSpreadTrading, etc.
- [Real-Time](https://finmind.github.io/tutor/TaiwanMarket/RealTime/): taiwan_stock_tick_snapshot, TaiwanFutOptTickInfo, taiwan_futures_snapshot, taiwan_options_snapshot
- [Convertible Bond](https://finmind.github.io/tutor/TaiwanMarket/ConvertibleBond/): TaiwanStockConvertibleBondInfo, TaiwanStockConvertibleBondDaily, TaiwanStockConvertibleBondInstitutionalInvestors, TaiwanStockConvertibleBondDailyOverview
- [Others](https://finmind.github.io/tutor/TaiwanMarket/Others/): TaiwanStockNews, TaiwanBusinessIndicator, TaiwanStockIndustryChain

### International Markets

- [US Market](https://finmind.github.io/tutor/UnitedStatesMarket/DataList/): USStockInfo, USStockPrice, USStockPriceMinute
- [UK Market](https://finmind.github.io/tutor/UnitedKingdomMarket/DataList/): UKStockInfo, UKStockPrice
- [Europe Market](https://finmind.github.io/tutor/EuropeMarket/DataList/): EuropeStockInfo, EuropeStockPrice
- [Japan Market](https://finmind.github.io/tutor/JapanMarket/DataList/): JapanStockInfo, JapanStockPrice

### Global Economic Data

- [Exchange Rate](https://finmind.github.io/tutor/ExchangeRate/): TaiwanExchangeRate (19 currencies: USD, EUR, JPY, GBP, CNY, HKD, KRW, SGD, AUD, CAD, CHF, NZD, ZAR, SEK, THB, IDR, MYR, PHP, VND)
- [Interest Rate](https://finmind.github.io/tutor/InterestRate/): InterestRate (12 central banks: FED, ECB, BOJ, BOE, PBOC, RBA, BOC, RBNZ, RBI, CBR, BCB, SNB)
- [Commodities](https://finmind.github.io/tutor/Materials/): GoldPrice, CrudeOilPrices (Brent, WTI)
- [US Government Bonds](https://finmind.github.io/tutor/GovernmentBondsYield/): GovernmentBondsYield (1M to 30Y maturities)
- [CNN Fear & Greed Index](https://finmind.github.io/tutor/Others/): CnnFearGreedIndex

### Analysis Tools

- [Backtesting](https://finmind.github.io/tutor/analysis/Backtesting/): Strategy backtesting framework
- [K-Line Chart](https://finmind.github.io/tutor/analysis/Kline/): Candlestick chart visualization
- [Dashboard](https://finmind.github.io/tutor/analysis/CustomerDashboardWebServer/): Custom dashboard web server
- [Treemap](https://finmind.github.io/tutor/analysis/SnapshotTreemap/): Real-time market treemap

## Links

- [GitHub](https://github.com/FinMind/FinMind)
- [Official Website](https://finmindtrade.com/)
- [API Schema](https://finmindtrade.com/analysis/#/data/document)