Quick start with FinMind Finance data API¶
This guide walks you through how to use the FinMind data API.
-
Rate limit
Request limit: 600/hour with token, 300/hour without token.
After registering at FinMind and verifying your email, attaching thetokenparameter raises your limit to 600/hour.
Get the token by signing in on the official site.
FinMind data API has four main endpoints¶
-
Login API
Get a token; pass it on subsequent calls to raise your rate limit.
-
Data API
Fetch a dataset. For example, query Taiwan stock prices via
TaiwanStockPrice. -
Datalist API
Each dataset takes parameters such as
data_id. Use this endpoint to discover the available values — for example, list every currency available forTaiwanExchangeRate. -
Translation API
Some columns are only labeled in English with cryptic names. This endpoint returns the Chinese name. For example,
AccountsPayablein the balance sheet maps to 應付帳款 (accounts payable).
API description¶
login¶
Request parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| user_id | str | N | User ID — register for higher quota. |
| password | str | N | User password — register for higher quota. |
Data API¶
Request parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| dataset | str | Y | Dataset name |
| data_id | str | N | Data identifier (e.g., stock id) |
| start_date | str | N | Start date. With end_date, returns the range; alone, returns from start_date to latest. At least one of start_date / end_date is required. |
| end_date | str | N | End date. With start_date, returns the range; alone, returns up to end_date. At least one of start_date / end_date is required. |
| token | str | N | User token — see Login to obtain one. |
Datalist API¶
Request parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| dataset | str | Y | Dataset name |
| user_id | str | N | User ID — register for higher quota. |
| password | str | N | User password — register for higher quota. |
Translation API¶
Request parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| dataset | str | Y | Dataset name |
| user_id | str | N | User ID — register for higher quota. |
| password | str | N | User password — register for higher quota. |