FinMind

1.9.10 verified Sat May 09 auth: no python

FinMind is a Python library for mining financial data, primarily covering Taiwan stock, futures, and options markets. Version 1.9.10 provides datasets via API calls, with a focus on Taiwan market data. The library supports token-based authentication and offers a range of data retrieval methods. Release cadence is irregular, with frequent minor updates.

pip install finmind

Common errors

error ImportError: cannot import name 'login' from 'finmind.login' ↓

cause The `login` function was removed in v1.9.3.

fix

Replace with from finmind.login import login_by_token.

error KeyError: 'data' ↓

cause API response does not contain 'data' key, possibly due to invalid token or incorrect dataset name.

fix

Verify your token is valid and the dataset name is correct (e.g., 'TaiwanStockInfo').

error AttributeError: 'NoneType' object has no attribute 'data' ↓

cause FinData object returned None, likely because login failed or token is missing.

fix

Ensure you called login_by_token(token) and passed token to FinData.

Warnings

breaking In version 1.9.3, the `login` function was removed. Only `login_by_token` is supported now. ↓

fix Use `from finmind.login import login_by_token` instead of `from finmind.login import login`.

gotcha Many datasets require a `token` parameter even after login. Always pass `token` to `FinData`. ↓

fix Ensure you include `token=your_token` when calling `FinData(...)`.

deprecated The `use_object` parameter for bulk downloads might be deprecated in future versions. Check docs for alternatives. ↓

fix Monitor release notes; continue using `use_object=True` if needed.

Imports

FinData

wrong

from finmind import FinData

correct

from finmind.database import FinData

FinData is in the database module, not top-level.

login_by_token

wrong

from finmind import login_by_token

correct

from finmind.login import login_by_token

login_by_token is in the login module.

TaiwanStockInfo

from finmind.database import TaiwanStockInfo

Quickstart

import pandas as pd
from finmind.login import login_by_token
from finmind.database import FinData

# Login with token (get token from https://finmind.github.io/)
token = 'YOUR_TOKEN_HERE'
login_by_token(token)

# Get Taiwan stock info
df = FinData('TaiwanStockInfo', token=token).data()
print(df.head())