FinMind

https://finmind.github.io/
Admin
FinMind is an open-source financial data platform providing 75+ Taiwan market datasets and...
Tokens:12,842
Snippets:139
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Fetch Dataset via REST API

Source: https://finmind.github.io/llms-full.txt

Example of querying Taiwan stock price data using a GET request with authentication headers.

```http
GET https://api.finmindtrade.com/api/v4/data?dataset=TaiwanStockPrice&data_id=2330&start_date=2020-04-01&end_date=2020-04-12
Authorization: Bearer {token}
```

```python
import requests
url = "https://api.finmindtrade.com/api/v4/data"
headers = {"Authorization": "Bearer your_token"}
params = {
    "dataset": "TaiwanStockPrice",
    "data_id": "2330",
    "start_date": "2020-04-01",
    "end_date": "2020-04-12",
}
resp = requests.get(url, headers=headers, params=params)
data = resp.json()
```

--------------------------------

### GET /data

Source: https://finmind.github.io/llms.txt

Fetches a specific dataset based on the provided parameters.

```APIDOC
## GET /data

### Description
Retrieves financial data for a specified dataset and identifier.

### Method
GET

### Endpoint
/data

### Parameters
#### Query Parameters
- **dataset** (string) - Required - The name of the dataset to query.
- **data_id** (string) - Optional - The specific identifier for the data.
- **start_date** (string) - Optional - Start date for the data range.
- **end_date** (string) - Optional - End date for the data range.
- **token** (string) - Optional - Authentication token.
```

--------------------------------

### GET /api/v4/storage_objects

Source: https://finmind.github.io/llms-full.txt

Bulk download endpoint for daily trading reports, returning a parquet file via a signed URL.

```APIDOC
## GET /api/v4/storage_objects

### Description
Provides bulk download of daily trading reports in parquet format via a signed URL. This ignores individual data_id or securities_trader_id parameters.

### Method
GET

### Endpoint
/api/v4/storage_objects

### Parameters
#### Query Parameters
- **dataset** (string) - Required - The dataset name (e.g., TaiwanStockTradingDailyReport or TaiwanStockWarrantTradingDailyReport).
- **date** (string) - Required - The date for the bulk report (YYYY-MM-DD).
```

--------------------------------

### GET /api/v4/storage_objects

Source: https://finmind.github.io/llms-full.txt

Bulk download endpoint for specific datasets, such as TaiwanStockKBar, returning a signed URL for parquet data.

```APIDOC
## GET /api/v4/storage_objects

### Description
Retrieves a bulk download link for a specified dataset and date, returning a signed URL for parquet data.

### Method
GET

### Endpoint
/api/v4/storage_objects

### Parameters
#### Query Parameters
- **dataset** (string) - Required - The dataset identifier (e.g., TaiwanStockKBar)
- **date** (string) - Required - The date for the data (YYYY-MM-DD)

### Response
#### Success Response (200)
- **url** (string) - Signed URL to download the parquet file
```

--------------------------------

### GET /data

Source: https://finmind.github.io/openapi.yaml

Fetches specific financial datasets based on the provided dataset name and identifier.

```APIDOC
## GET /data

### Description
Query any FinMind dataset. Use the `dataset` parameter to select the data type and `data_id` for specific assets.

### Method
GET

### Endpoint
/data

### Parameters
#### Query Parameters
- **dataset** (string) - Required - The name of the dataset to retrieve (e.g., TaiwanStockPrice, USStockPrice).
- **data_id** (string) - Optional - The specific stock ID, futures ID, or currency code.
```

--------------------------------

### GET https://api.web.finmindtrade.com/v2/user_info

Source: https://finmind.github.io/llms-full.txt

Retrieves current API usage statistics and quota limits.

```APIDOC
## GET https://api.web.finmindtrade.com/v2/user_info

### Description
Check current API usage and quota.

### Method
GET

### Endpoint
https://api.web.finmindtrade.com/v2/user_info

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer {token}

### Response
#### Success Response (200)
- **user_count** (int) - Current API usage count
- **api_request_limit** (int) - API usage limit
```

--------------------------------

### GET /api/v4/storage_objects

Source: https://finmind.github.io/llms-full.txt

Bulk download endpoint for retrieving whole-day parquet files for tick-level data.

```APIDOC
## GET /api/v4/storage_objects

### Description
Retrieves a whole-day parquet file for tick-level data via a signed URL.

### Method
GET

### Endpoint
/api/v4/storage_objects

### Parameters
#### Query Parameters
- **dataset** (string) - Required - The dataset name (e.g., TaiwanFuturesTick, TaiwanOptionTick)
- **date** (string) - Required - The date for the requested data (YYYY-MM-DD)
```

--------------------------------

### GET /translation

Source: https://finmind.github.io/llms.txt

Retrieves the English-Chinese column name mapping for a dataset.

```APIDOC
## GET /translation

### Description
Provides a mapping between English and Chinese column names for a specified dataset.

### Method
GET

### Endpoint
/translation
```

--------------------------------

### GET /translation

Source: https://finmind.github.io/openapi.yaml

Retrieves the Chinese-English mapping for column names within a specific dataset.

```APIDOC
## GET /translation

### Description
Get column name Chinese-English mapping.

### Method
GET

### Endpoint
/translation

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Dataset name (e.g. TaiwanStockPrice, TaiwanStockBalanceSheet)

### Response
#### Success Response (200)
- **msg** (string) - Status message
- **status** (integer) - HTTP status code
- **data** (array) - Column name translations
```

--------------------------------

### GET /datalist

Source: https://finmind.github.io/openapi.yaml

Retrieves a list of available data_id values for a specified dataset.

```APIDOC
## GET /datalist

### Description
List available data_id values for a dataset.

### Method
GET

### Endpoint
/datalist

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Dataset name (e.g. TaiwanStockPrice, TaiwanExchangeRate)

### Response
#### Success Response (200)
- **msg** (string) - Status message
- **status** (integer) - HTTP status code
- **data** (array) - List of available data_id values
```

--------------------------------

### GET https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report_secid_agg

Source: https://finmind.github.io/llms-full.txt

Retrieves the daily broker branch statistics report for a specific stock.

```APIDOC
## GET https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report_secid_agg

### Description
Retrieves the daily broker branch statistics report for a specific stock.

### Method
GET

### Endpoint
https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report_secid_agg

### Parameters
#### Query Parameters
- **data_id** (string) - Required - The stock ID (e.g., 2330)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Required - End date in YYYY-MM-DD format
```

--------------------------------

### GET https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report

Source: https://finmind.github.io/llms-full.txt

Retrieves daily trading data for specific stocks or brokers. This endpoint is exclusive and does not use the standard /api/v4/data path.

```APIDOC
## GET https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report

### Description
Retrieves daily trading data for specific stocks or brokers. Note that this endpoint requires a specific date and does not support start_date/end_date ranges.

### Method
GET

### Endpoint
https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report

### Parameters
#### Query Parameters
- **data_id** (string) - Optional - The stock ID to filter by.
- **securities_trader_id** (string) - Optional - The broker ID to filter by.
- **date** (string) - Required - The date for the report (YYYY-MM-DD).
```

--------------------------------

### Initialize Python SDK and Fetch Daily Stock Data

Source: https://finmind.github.io/llms.txt

Authenticate using a token and retrieve daily stock data for a specific identifier.

```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')
```

--------------------------------

### Optimize Data Loading Performance

Source: https://finmind.github.io/WhatIsNew

Demonstrates measuring the execution time for loading financial statements for all available stock IDs.

```python
from FinMind.Data import Load
import datetime

TaiwanStockInfo = Load.FinData(dataset = 'TaiwanStockInfo')
s = datetime.datetime.now()
TaiwanStockFinancialStatements = Load.FinData(dataset = 'FinancialStatements',select = list(TaiwanStockInfo['stock_id']),date = '2018-12-01')
t = datetime.datetime.now() - s
print(t)
0:00:01.861724
```

--------------------------------

### Load Taiwan Stock Monthly Revenue Data

Source: https://finmind.github.io/WhatIsNew

Retrieves monthly revenue data for a specific stock using the FinMind Load module.

```python
from FinMind.Data import Load
TaiwanStockMonthRevenue = Load.FinData(
    dataset = 'TaiwanStockMonthRevenue',
    select = '2330',
    date = '2018-01-01')
```

--------------------------------

### TaiwanFutOptTickInfo

Source: https://finmind.github.io/llms-full.txt

Retrieves an overview of real-time futures and options quotes.

```APIDOC
## TaiwanFutOptTickInfo

### Description
Retrieves an overview of real-time futures and options quotes.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanFutOptTickInfo'
```

--------------------------------

### Perform Async Batch Queries in Python

Source: https://finmind.github.io/llms.txt

Query multiple stock identifiers concurrently by setting use_async to True. This feature is limited to datasets requiring a data_id parameter.

```python
from FinMind.data import DataLoader
api = DataLoader()
api.login_by_token(api_token='your_token')
df = api.taiwan_stock_daily(
    stock_id_list=['2330', '2317', '2454', '3008'],
    start_date='2024-01-01',
    end_date='2024-12-31',
    use_async=True,
)
```

--------------------------------

### POST /login

Source: https://finmind.github.io/openapi.yaml

Authenticates a user and returns an access token required for subsequent API requests.

```APIDOC
## POST /login

### Description
Authenticates the user with their credentials to retrieve an access token.

### Method
POST

### Endpoint
/login

### Request Body
- **user_id** (string) - Required - The user's account identifier.
- **password** (string) - Required - The user's password.

### Response
#### Success Response (200)
- **token** (string) - The authentication token.
```

--------------------------------

### taiwan_options_snapshot

Source: https://finmind.github.io/llms-full.txt

Retrieves real-time snapshot data for Taiwan options.

```APIDOC
## taiwan_options_snapshot

### Description
Retrieves real-time snapshot data for Taiwan options.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'taiwan_options_snapshot'
- **data_id** (string) - Optional - Options ID (e.g., TXO)
```

--------------------------------

### TaiwanAssetSwapOptionDaily

Source: https://finmind.github.io/llms-full.txt

Retrieves daily transaction information for asset swap options.

```APIDOC
## TaiwanAssetSwapOptionDaily

### Description
Retrieves daily transaction information for asset swap options.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanAssetSwapOptionDaily'
- **data_id** (string) - Required - The stock or instrument ID
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Required - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanAssetSwapFixedIncomeDaily

Source: https://finmind.github.io/llms-full.txt

Retrieves daily transaction information for asset swap fixed income.

```APIDOC
## TaiwanAssetSwapFixedIncomeDaily

### Description
Retrieves daily transaction information for asset swap fixed income instruments.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanAssetSwapFixedIncomeDaily'
- **data_id** (string) - Required - The stock or instrument ID
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Required - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockPriceLimit

Source: https://finmind.github.io/llms-full.txt

Retrieves daily price limit information for Taiwan stocks.

```APIDOC
## TaiwanStockPriceLimit

### Description
Retrieves daily limit up and limit down prices for stocks.

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockPriceLimit'
- **data_id** (str) - Optional - Specific stock ID
- **start_date** (str) - Required - Start date in YYYY-MM-DD format
```

--------------------------------

### Bulk Download Tick Data

Source: https://finmind.github.io/llms-full.txt

Retrieve whole-day tick data in parquet format using the SponsorPro API or Python SDK.

```http
GET /api/v4/storage_objects?dataset=TaiwanStockPriceTick&date=2019-01-02
```

```python
api.taiwan_stock_tick(date='2019-01-02', use_object=True)
```

--------------------------------

### Bulk Download TaiwanStockWarrantTradingDailyReport

Source: https://finmind.github.io/llms-full.txt

Retrieve whole-day parquet data for warrant trading reports via a signed URL or the Python SDK.

```http
GET /api/v4/storage_objects?dataset=TaiwanStockWarrantTradingDailyReport&date=2023-06-21
```

```python
api.taiwan_stock_warrant_trading_daily_report(date='2023-06-21', use_object=True)
```

--------------------------------

### TaiwanStockConvertibleBondInfo

Source: https://finmind.github.io/llms-full.txt

Retrieves the overview information for Taiwan convertible bonds.

```APIDOC
## GET TaiwanStockConvertibleBondInfo

### Description
Retrieves the overview information for Taiwan convertible bonds.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockConvertibleBondInfo'
```

--------------------------------

### TaiwanFuturesSpreadTrading

Source: https://finmind.github.io/llms-full.txt

Retrieves spread trading data for Taiwan futures.

```APIDOC
## TaiwanFuturesSpreadTrading

### Description
Retrieves spread trading data for Taiwan futures.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanFuturesSpreadTrading
- **data_id** (string) - Required - The futures ID (e.g., TX)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### Bulk Download Taiwan Stock KBar Data

Source: https://finmind.github.io/llms-full.txt

Access whole-day parquet files for Taiwan stock KBar data using the API or Python SDK.

```http
GET /api/v4/storage_objects?dataset=TaiwanStockKBar&date=2026-01-02
```

```python
api.taiwan_stock_kbar(date='2026-01-02', use_object=True)
```

--------------------------------

### TaiwanStockMonthRevenue

Source: https://finmind.github.io/llms-full.txt

Retrieves monthly revenue data for Taiwan stocks.

```APIDOC
## TaiwanStockMonthRevenue

### Description
Retrieves monthly revenue data for stocks listed on TWSE, TPEx, and Emerging markets.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockMonthRevenue'
- **data_id** (string) - Optional - Stock ID (e.g., 2330)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format

### Response
- **date** (string) - Date of record
- **stock_id** (string) - Stock identifier
- **country** (string) - Country code
- **revenue** (int64) - Revenue amount
- **revenue_month** (int64) - Month of revenue
- **revenue_year** (int64) - Year of revenue
- **create_time** (string) - Record creation time
```

--------------------------------

### TaiwanStockConvertibleBondMonthlyAnalysis

Source: https://finmind.github.io/llms-full.txt

Retrieves monthly analysis information for Taiwan convertible bonds.

```APIDOC
## GET TaiwanStockConvertibleBondMonthlyAnalysis

### Description
Retrieves monthly analysis information for Taiwan convertible bonds.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockConvertibleBondMonthlyAnalysis'
- **data_id** (string) - Required - The convertible bond ID
- **start_date** (string) - Required - Start date (YYYY-MM-DD)
- **end_date** (string) - Required - End date (YYYY-MM-DD)
```

--------------------------------

### TaiwanStockConvertibleBondDailyOverview

Source: https://finmind.github.io/llms-full.txt

Retrieves daily overview information for Taiwan convertible bonds.

```APIDOC
## GET TaiwanStockConvertibleBondDailyOverview

### Description
Retrieves daily overview information for Taiwan convertible bonds.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockConvertibleBondDailyOverview'
- **data_id** (string) - Optional - The convertible bond ID
- **start_date** (string) - Required - Start date (YYYY-MM-DD)
- **end_date** (string) - Optional - End date (YYYY-MM-DD)
```

--------------------------------

### Bulk Download Taiwan Option Tick Data

Source: https://finmind.github.io/llms-full.txt

Retrieve whole-day parquet files for option tick data via API or Python SDK.

```http
GET /api/v4/storage_objects?dataset=TaiwanOptionTick&date=2026-01-02
```

```python
api.taiwan_option_tick(date='2026-01-02', use_object=True)
```

--------------------------------

### taiwan_futures_snapshot

Source: https://finmind.github.io/llms-full.txt

Retrieves real-time snapshot data for Taiwan futures.

```APIDOC
## taiwan_futures_snapshot

### Description
Retrieves real-time snapshot data for Taiwan futures.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'taiwan_futures_snapshot'
- **data_id** (string) - Optional - Futures ID (e.g., TXF)
```

--------------------------------

### Bulk Download TaiwanStockTradingDailyReport

Source: https://finmind.github.io/llms-full.txt

Retrieve whole-day parquet data for trading reports via a signed URL or the Python SDK.

```http
GET /api/v4/storage_objects?dataset=TaiwanStockTradingDailyReport&date=2022-06-16
```

```python
api.taiwan_stock_trading_daily_report(date='2022-06-16', use_object=True)
```

--------------------------------

### Check API Usage and Quota

Source: https://finmind.github.io/llms-full.txt

Retrieve current API usage statistics and limits using the Python SDK or direct HTTP requests.

```python
# Package
from FinMind.data import FinMindApi
api = FinMindApi()
api.login_by_token(token)
print(api.api_usage_limit)

# Requests
import requests
headers = {"Authorization": f"Bearer {token}"}
url = "https://api.web.finmindtrade.com/v2/user_info"
resp = requests.get(url, headers=headers)
resp.json()["user_count"]  # 使用次數
resp.json()["api_request_limit"]  # api 使用上限
```

--------------------------------

### TaiwanStockMarketValueWeight

Source: https://finmind.github.io/llms-full.txt

Retrieves market value weight data for Taiwan stocks.

```APIDOC
## TaiwanStockMarketValueWeight

### Description
Provides market value weight data. Requires Backer/Sponsor tier.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockMarketValueWeight'
- **data_id** (string) - Optional - Stock ID
- **start_date** (string) - Required - Start date
- **end_date** (string) - Optional - End date

### Response
- **rank** (int64) - Market rank
- **stock_id** (string) - Stock identifier
- **stock_name** (string) - Stock name
- **weight_per** (float32) - Weight percentage
- **date** (string) - Date of record
- **type** (string) - Market type (twse/tpex)
```

--------------------------------

### TaiwanStockConvertibleBondDaily

Source: https://finmind.github.io/llms-full.txt

Retrieves daily transaction information for Taiwan convertible bonds.

```APIDOC
## GET TaiwanStockConvertibleBondDaily

### Description
Retrieves daily transaction information for Taiwan convertible bonds.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockConvertibleBondDaily'
- **data_id** (string) - Optional - The convertible bond ID
- **start_date** (string) - Required - Start date (YYYY-MM-DD)
- **end_date** (string) - Optional - End date (YYYY-MM-DD)
```

--------------------------------

### TaiwanStockDividend

Source: https://finmind.github.io/llms-full.txt

Retrieves dividend policy information for Taiwan stocks.

```APIDOC
## GET TaiwanStockDividend

### Description
Retrieves dividend policy details for specific stocks or market-wide on a given date.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockDividend'
- **data_id** (string) - Optional - The stock ID to filter by
- **start_date** (string) - Required - The start date for the dividend data
```

--------------------------------

### TaiwanStockConvertibleBondPutProvision

Source: https://finmind.github.io/llms-full.txt

Retrieves put provision schedule for Taiwan convertible bonds.

```APIDOC
## GET TaiwanStockConvertibleBondPutProvision

### Description
Retrieves put provision schedule for Taiwan convertible bonds.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockConvertibleBondPutProvision'
- **data_id** (string) - Optional - The convertible bond ID
- **start_date** (string) - Required - Start date (YYYY-MM-DD)
- **end_date** (string) - Required - End date (YYYY-MM-DD)
```

--------------------------------

### TaiwanOptionVix

Source: https://finmind.github.io/llms-full.txt

Retrieves historical Taiwan Option VIX data.

```APIDOC
## TaiwanOptionVix

### Description
Retrieves historical volatility index data for Taiwan options.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanOptionVix'
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Required - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanOptionOpenInterestLargeTraders

Source: https://finmind.github.io/llms-full.txt

Retrieves large trader open interest data for Taiwan options.

```APIDOC
## TaiwanOptionOpenInterestLargeTraders

### Description
Retrieves large trader open interest data for Taiwan options.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanOptionOpenInterestLargeTraders
- **data_id** (string) - Optional - The option ID (e.g., CA)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanOptionDealerTradingVolumeDaily

Source: https://finmind.github.io/llms-full.txt

Retrieves daily trading volume for Taiwan options by dealer.

```APIDOC
## TaiwanOptionDealerTradingVolumeDaily

### Description
Retrieves daily trading volume for Taiwan options by dealer.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanOptionDealerTradingVolumeDaily
- **data_id** (string) - Optional - The option ID (e.g., TXO)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockFinancialStatements

Source: https://finmind.github.io/llms-full.txt

Retrieves comprehensive financial statements for Taiwan stocks.

```APIDOC
## GET TaiwanStockFinancialStatements

### Description
Retrieves financial statement data. Supports querying by specific stock ID or all stocks for a given date.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockFinancialStatements'
- **data_id** (string) - Optional - The stock ID to filter by
- **start_date** (string) - Required - The start date for the financial data
```

--------------------------------

### Bulk Download Taiwan Futures Tick Data

Source: https://finmind.github.io/llms-full.txt

Retrieve whole-day parquet files for futures tick data via API or Python SDK.

```http
GET /api/v4/storage_objects?dataset=TaiwanFuturesTick&date=2026-01-02
```

```python
api.taiwan_futures_tick(date='2026-01-02', use_object=True)
```

--------------------------------

### TaiwanFuturesOpenInterestLargeTraders

Source: https://finmind.github.io/llms-full.txt

Retrieves large trader open interest data for Taiwan futures.

```APIDOC
## TaiwanFuturesOpenInterestLargeTraders

### Description
Retrieves large trader open interest data for Taiwan futures.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanFuturesOpenInterestLargeTraders
- **data_id** (string) - Optional - The futures ID (e.g., TJF)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockBalanceSheet

Source: https://finmind.github.io/llms-full.txt

Retrieves balance sheet data for Taiwan stocks.

```APIDOC
## GET TaiwanStockBalanceSheet

### Description
Retrieves balance sheet information for specific stocks or market-wide on a given date.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockBalanceSheet'
- **data_id** (string) - Optional - The stock ID to filter by
- **start_date** (string) - Required - The start date for the balance sheet data
```

--------------------------------

### TaiwanFuturesFinalSettlementPrice

Source: https://finmind.github.io/llms-full.txt

Retrieves final settlement prices for Taiwan futures.

```APIDOC
## TaiwanFuturesFinalSettlementPrice

### Description
Retrieves final settlement prices for Taiwan futures.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanFuturesFinalSettlementPrice
- **data_id** (string) - Required - The futures ID (e.g., TX)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### taiwan_stock_tick_snapshot

Source: https://finmind.github.io/llms-full.txt

Retrieves real-time tick snapshot data for Taiwan stocks and indices.

```APIDOC
## taiwan_stock_tick_snapshot

### Description
Retrieves real-time tick snapshot data for Taiwan stocks or specific index codes.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'taiwan_stock_tick_snapshot'
- **data_id** (string) - Optional - Stock ID or 3-digit index code
```

--------------------------------

### TaiwanStockCapitalReductionReferencePrice

Source: https://finmind.github.io/llms-full.txt

Retrieves reference prices for stocks after capital reduction.

```APIDOC
## TaiwanStockCapitalReductionReferencePrice

### Description
Provides reference prices for stocks undergoing capital reduction.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockCapitalReductionReferencePrice'
- **data_id** (string) - Optional - Stock ID
- **start_date** (string) - Required - Start date in YYYY-MM-DD format

### Response
- **date** (string) - Date of record
- **stock_id** (string) - Stock identifier
- **ClosingPriceonTheLastTradingDay** (float) - Last trading day closing price
- **PostReductionReferencePrice** (float) - Reference price after reduction
- **LimitUp** (float) - Limit up price
- **LimitDown** (float) - Limit down price
- **OpeningReferencePrice** (float) - Opening reference price
- **ExrightReferencePrice** (float) - Ex-right reference price
- **ReasonforCapitalReduction** (string) - Reason for the reduction
```

--------------------------------

### TaiwanStockMarginPurchaseShortSale

Source: https://finmind.github.io/llms-full.txt

Retrieves margin purchase and short sale data for individual stocks.

```APIDOC
## TaiwanStockMarginPurchaseShortSale

### Description
Retrieves margin purchase and short sale balances and transactions for individual stocks.

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockMarginPurchaseShortSale'
- **data_id** (str) - Optional - Specific stock ID
- **start_date** (str) - Required - Start date in YYYY-MM-DD format
- **end_date** (str) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockDividendResult

Source: https://finmind.github.io/llms-full.txt

Retrieves the results of ex-dividend and ex-rights events for Taiwan stocks.

```APIDOC
## GET TaiwanStockDividendResult

### Description
Retrieves ex-dividend and ex-rights results for specific stocks or market-wide on a given date.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockDividendResult'
- **data_id** (string) - Optional - The stock ID to filter by
- **start_date** (string) - Required - The start date for the dividend result data
```

--------------------------------

### TaiwanFuturesDealerTradingVolumeDaily

Source: https://finmind.github.io/llms-full.txt

Retrieves daily trading volume for Taiwan futures by dealer.

```APIDOC
## TaiwanFuturesDealerTradingVolumeDaily

### Description
Retrieves daily trading volume for Taiwan futures by dealer.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanFuturesDealerTradingVolumeDaily
- **data_id** (string) - Optional - The futures ID (e.g., TX)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanOptionFinalSettlementPrice

Source: https://finmind.github.io/llms-full.txt

Retrieves final settlement prices for Taiwan options.

```APIDOC
## TaiwanOptionFinalSettlementPrice

### Description
Retrieves final settlement prices for Taiwan options.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanOptionFinalSettlementPrice
- **data_id** (string) - Required - The option ID (e.g., TXO)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockIndustryChainMoneyFlow

Source: https://finmind.github.io/llms-full.txt

Retrieves daily industry chain money flow data for the Taiwan stock market.

```APIDOC
## GET TaiwanStockIndustryChainMoneyFlow

### Description
Retrieves daily industry chain money flow data. Note that this endpoint requires a specific start_date and does not support end_date.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockIndustryChainMoneyFlow'
- **start_date** (string) - Required - The date to retrieve data for (YYYY-MM-DD)
```

--------------------------------

### List of Central Bank Interest Rates

Source: https://finmind.github.io/WhatIsNew

A list of supported central banks for interest rate data.

```text
  FED Federal Reserve System 美國
  ECB European Central Bank 歐洲
  BOE Bank of England 英國
  SNB Swiss National Bank 瑞士
  RBA Reserve Bank of Australia 澳洲
  BOC Bank of Canada 加拿大
  RBNZ Reserve Bank of New Zealand 紐西蘭
  BOJ Bank of Japan 日本
  CBR The Central Bank of the Russian Federation 俄羅斯
  RBI Reserve Bank of India 印度
  PBOC People's Bank of China  中國
  BCB Banco Central do Brasil 巴西
```

--------------------------------

### TaiwanStockPriceTick

Source: https://finmind.github.io/llms-full.txt

Retrieves historical tick-level data for Taiwan stocks.

```APIDOC
## GET TaiwanStockPriceTick

### Description
Retrieves historical tick-level trading data. Limited to single day per request.

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockPriceTick'
- **data_id** (str) - Required - The stock ID
- **start_date** (str) - Required - Date in YYYY-MM-DD format

### Response
- **date** (str) - Date of record
- **stock_id** (str) - Stock identifier
- **deal_price** (float64) - Price of the deal
- **volume** (int64) - Volume of the tick
- **Time** (str) - Time of the tick
- **TickType** (str) - 0=unknown, 1=buyer-initiated, 2=seller-initiated
```

--------------------------------

### TaiwanStockCashFlowsStatement

Source: https://finmind.github.io/llms-full.txt

Retrieves cash flow statement data for Taiwan stocks.

```APIDOC
## GET TaiwanStockCashFlowsStatement

### Description
Retrieves cash flow statement information for specific stocks or market-wide on a given date.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockCashFlowsStatement'
- **data_id** (string) - Optional - The stock ID to filter by
- **start_date** (string) - Required - The start date for the cash flow data
```

--------------------------------

### TaiwanBusinessIndicator

Source: https://finmind.github.io/llms-full.txt

Retrieves monthly business indicator data for Taiwan.

```APIDOC
## TaiwanBusinessIndicator

### Description
Retrieves monthly business indicator data for Taiwan within a specified date range.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanBusinessIndicator'
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Required - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockSplitPrice

Source: https://finmind.github.io/llms-full.txt

Retrieves reference prices after stock splits.

```APIDOC
## TaiwanStockSplitPrice

### Description
Provides reference prices for stocks after split or reverse split events.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockSplitPrice'

### Response
- **date** (string) - Date of record
- **stock_id** (string) - Stock identifier
- **type** (string) - Split type
- **before_price** (float) - Price before split
- **after_price** (float) - Price after split
- **max_price** (float) - Max price
- **min_price** (float) - Min price
- **open_price** (float) - Open price
```

--------------------------------

### USStockPrice

Source: https://finmind.github.io/llms-full.txt

Retrieves daily historical price data for US stocks.

```APIDOC
## USStockPrice

### Description
Retrieves daily historical price data for US stocks within a specified date range.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'USStockPrice'
- **data_id** (string) - Required - The stock ticker symbol
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Required - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanOptionInstitutionalInvestorsAfterHours

Source: https://finmind.github.io/llms-full.txt

Retrieves after-hours institutional investor trading data for Taiwan options.

```APIDOC
## TaiwanOptionInstitutionalInvestorsAfterHours

### Description
Retrieves after-hours institutional investor trading data for Taiwan options.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanOptionInstitutionalInvestorsAfterHours
- **data_id** (string) - Optional - The option ID (e.g., TXO)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanFuturesInstitutionalInvestorsAfterHours

Source: https://finmind.github.io/llms-full.txt

Retrieves after-hours institutional investor trading data for Taiwan futures.

```APIDOC
## TaiwanFuturesInstitutionalInvestorsAfterHours

### Description
Retrieves after-hours institutional investor trading data for Taiwan futures.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - TaiwanFuturesInstitutionalInvestorsAfterHours
- **data_id** (string) - Optional - The futures ID (e.g., TX)
- **start_date** (string) - Required - Start date in YYYY-MM-DD format
- **end_date** (string) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### Global Economic Data Access

Source: https://finmind.github.io/llms-full.txt

General interface for retrieving economic datasets including TaiwanExchangeRate, InterestRate, GoldPrice, CrudeOilPrices, GovernmentBondsYield, and CnnFearGreedIndex.

```APIDOC
## Global Economic Data Query

### Description
Retrieves historical economic data based on the specified dataset and parameters.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - The name of the dataset (e.g., TaiwanExchangeRate, InterestRate, GoldPrice, CrudeOilPrices, GovernmentBondsYield, CnnFearGreedIndex)
- **data_id** (string) - Optional - Specific identifier for the data series (e.g., USD for exchange rates, FED for interest rates, WTI for oil)
- **start_date** (string) - Optional - Start date for the data range (YYYY-MM-DD)
- **end_date** (string) - Optional - End date for the data range (YYYY-MM-DD)
```

--------------------------------

### TaiwanStockParValueChange

Source: https://finmind.github.io/llms-full.txt

Retrieves reference prices after par value changes.

```APIDOC
## TaiwanStockParValueChange

### Description
Provides reference prices for stocks after a change in par value.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockParValueChange'
- **start_date** (string) - Required - Start date

### Response
- **date** (string) - Date of record
- **stock_id** (string) - Stock identifier
- **stock_name** (string) - Stock name
- **before_close** (float64) - Closing price before change
- **after_ref_close** (float64) - Reference closing price after change
- **after_ref_max** (float64) - Reference max price after change
- **after_ref_min** (float64) - Reference min price after change
- **after_ref_open** (float64) - Reference open price after change
```

--------------------------------

### TaiwanStockMarketValue

Source: https://finmind.github.io/llms-full.txt

Retrieves market value data for Taiwan stocks.

```APIDOC
## TaiwanStockMarketValue

### Description
Provides market value data for Taiwan stocks. Requires Backer/Sponsor tier.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockMarketValue'
- **data_id** (string) - Optional - Stock ID
- **start_date** (string) - Required - Start date
- **end_date** (string) - Optional - End date

### Response
- **date** (string) - Date of record
- **stock_id** (string) - Stock identifier
- **market_value** (int64) - Market value
```

--------------------------------

### TaiwanStockInstitutionalInvestorsBuySell

Source: https://finmind.github.io/llms-full.txt

Retrieves institutional investor buy/sell data for individual stocks.

```APIDOC
## TaiwanStockInstitutionalInvestorsBuySell

### Description
Retrieves daily buy and sell volumes by institutional investors for specific stocks.

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockInstitutionalInvestorsBuySell'
- **data_id** (str) - Optional - Specific stock ID
- **start_date** (str) - Required - Start date in YYYY-MM-DD format
- **end_date** (str) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### Retrieve Taiwan Futures Spread Tick Data

Source: https://finmind.github.io/llms-full.txt

Access per-trade data for futures calendar spreads using the Python SDK.

```python
api.taiwan_futures_spread_tick(futures_id='CAF', date='2026-06-09')
```

--------------------------------

### TaiwanStockDelisting

Source: https://finmind.github.io/llms-full.txt

Retrieves information about delisted Taiwan stocks.

```APIDOC
## TaiwanStockDelisting

### Description
Provides a list of stocks that have been delisted from the market.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockDelisting'

### Response
- **date** (string) - Delisting date
- **stock_id** (string) - Stock identifier
- **stock_name** (string) - Stock name
```

--------------------------------

### TaiwanStockPrice

Source: https://finmind.github.io/llms-full.txt

Retrieves daily stock price information for a specific stock or all stocks.

```APIDOC
## GET TaiwanStockPrice

### Description
Retrieves daily成交 (trading) information for Taiwan stocks. Data is available from 1994-10-01 to present.

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockPrice'
- **data_id** (str) - Optional - The stock ID to filter by
- **start_date** (str) - Required - Start date in YYYY-MM-DD format
- **end_date** (str) - Optional - End date in YYYY-MM-DD format

### Response
- **date** (str) - Date of record
- **stock_id** (str) - Stock identifier
- **Trading_Volume** (int64) - Trading volume
- **Trading_money** (int64) - Trading money
- **open** (float64) - Opening price
- **max** (float64) - Maximum price
- **min** (float64) - Minimum price
- **close** (float64) - Closing price
- **spread** (float64) - Price spread
- **Trading_turnover** (float32) - Trading turnover
```

--------------------------------

### TaiwanStockDayTradingSuspension

Source: https://finmind.github.io/llms-full.txt

Retrieves the day trading suspension schedule for Taiwan stocks.

```APIDOC
## TaiwanStockDayTradingSuspension

### Description
Retrieves the pre-announcement table for day trading suspension (sell before buy).

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockDayTradingSuspension'
- **start_date** (str) - Optional - Start date in YYYY-MM-DD format
- **end_date** (str) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### Handle Rate Limit Exceeded

Source: https://finmind.github.io/llms-full.txt

The API returns an HTTP 402 status code when the request quota is exceeded.

```json
{'msg': 'Requests reach the upper limit. https://finmindtrade.com/', 'status': 402}
```

--------------------------------

### TaiwanStockShareholding

Source: https://finmind.github.io/llms-full.txt

Retrieves foreign investment shareholding data for individual stocks.

```APIDOC
## TaiwanStockShareholding

### Description
Retrieves foreign investment shareholding statistics including remaining shares and ratios.

### Parameters
#### Query Parameters
- **dataset** (str) - Required - Must be 'TaiwanStockShareholding'
- **data_id** (str) - Optional - Specific stock ID
- **start_date** (str) - Required - Start date in YYYY-MM-DD format
- **end_date** (str) - Optional - End date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockNews

Source: https://finmind.github.io/llms-full.txt

Retrieves news related to a specific stock ID for a single day.

```APIDOC
## TaiwanStockNews

### Description
Retrieves news related to a specific stock ID for a single day.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockNews'
- **data_id** (string) - Required - The stock ID
- **start_date** (string) - Required - The date in YYYY-MM-DD format
```

--------------------------------

### TaiwanStockConvertibleBondInstitutionalInvestors

Source: https://finmind.github.io/llms-full.txt

Retrieves daily institutional investor transaction information for Taiwan convertible bonds.

```APIDOC
## GET TaiwanStockConvertibleBondInstitutionalInvestors

### Description
Retrieves daily institutional investor transaction information for Taiwan convertible bonds.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockConvertibleBondInstitutionalInvestors'
- **data_id** (string) - Optional - The convertible bond ID
- **start_date** (string) - Required - Start date (YYYY-MM-DD)
- **end_date** (string) - Optional - End date (YYYY-MM-DD)
```

--------------------------------

### TaiwanStockDispositionSecuritiesPeriod

Source: https://finmind.github.io/llms-full.txt

Retrieves information regarding disposition securities in the Taiwan stock market.

```APIDOC
## GET TaiwanStockDispositionSecuritiesPeriod

### Description
Retrieves the list of disposition securities. Can be filtered by a specific stock ID or retrieved for all stocks on a given date range.

### Parameters
#### Query Parameters
- **dataset** (string) - Required - Must be 'TaiwanStockDispositionSecuritiesPeriod'
- **data_id** (string) - Optional - The stock ID to filter by
- **start_date** (string) - Required - Start date for the query
- **end_date** (string) - Optional - End date for the query
```

--------------------------------

### Access TaiwanStockTradingDailyReport Endpoint

Source: https://finmind.github.io/llms-full.txt

The endpoint for retrieving daily stock trading reports by stock or broker. Note that this endpoint requires a specific date and does not support date ranges.

```http
GET https://api.finmindtrade.com/api/v4/taiwan_stock_trading_daily_report
```
Tokens:
Raw