tw-stock

A command-line tool for quickly searching Taiwan stock market information, including real-time prices, market indices, and historical trading data.

Installation

npm install -g tw-stock

Commands

stock — Search stock information

tw-stock stock [stock_code]

| Option | Description | | --- | --- | | -l, --listed <listed> | Market type: tse (default) or otc | | -m, --multiple | Search multiple stock codes (hyphen-separated) | | -f, --favorite | Search stocks from favorite list | | -o, --oddLot | Search odd-lot trading data | | -d, --date <date> | Search historical data (YYYY-MM or YYYY-MM-DD) | | --details | Show detailed stock data (default: true) |

Examples:

# Search a single TSE stock
tw-stock stock 2330

# Search an OTC stock
tw-stock stock 6488 -l otc

# Search multiple stocks
tw-stock stock 2330-2317-2454 -m

# Search historical monthly data
tw-stock stock 2330 -d 2025-01

# Search historical daily data
tw-stock stock 2330 -d 2025-01-15

index — Search market indices

tw-stock index [code]

Supported indices: TAIEX, TWO, FRMSA

| Option | Description | | --- | --- | | -m, --multiple | Search multiple indices | | -t, --time <time...> | Specify time range (HHMM format, 0900–1330) | | -c, --chart | Display ASCII chart |

Examples:

# Search TAIEX (default)
tw-stock index

# Search with ASCII chart
tw-stock index TAIEX -c

# Search multiple indices
tw-stock index TAIEX-TWO -m

# Search within a specific time range
tw-stock index TAIEX -t 0900 1100

institutional — Institutional investors buy/sell data

tw-stock institutional [stock_code]

View daily buy/sell data from the three major institutional investors (三大法人買賣超). Without a stock code, displays the summary table.

| Option | Description | | --- | --- | | -l, --listed <listed> | Market type: tse (default) or otc | | -d, --date <date> | Search specific date (YYYY-MM-DD) | | -n, --number <number> | Number of results to show |

Examples:

# Show institutional summary for today
tw-stock institutional

# Show institutional data for a specific stock
tw-stock institutional 2330

# Show OTC institutional data for a specific date
tw-stock institutional 6488 -l otc -d 2025-01-15

rank — Daily stock ranking

tw-stock rank

Show daily stock ranking by price change or volume (當日漲跌幅排行).

| Option | Description | | --- | --- | | -l, --listed <listed> | Market type: tse (default) or otc | | -d, --date <date> | Search specific date (YYYY-MM-DD) | | -n, --number <number> | Number of results to show (default: 10) | | --losers | Show top losers instead of gainers | | --volume | Sort by volume |

Examples:

# Show top 10 gainers (default)
tw-stock rank

# Show top 20 losers
tw-stock rank --losers -n 20

# Show top 10 by volume for OTC
tw-stock rank --volume -l otc

# Show ranking for a specific date
tw-stock rank -d 2025-01-15

crawler — Update stock list

Crawl and update the local stock list from TWSE/TPEX exchanges.

tw-stock crawler

favorite — Manage favorite stocks

tw-stock favorite              # List all favorite stocks (default)
tw-stock favorite list         # List all favorite stocks
tw-stock favorite create       # Create favorite file
tw-stock favorite add <code>   # Add a stock code
tw-stock favorite delete <code> # Remove a stock code

completion — Shell tab-completion

tw-stock completion           # Setup shell tab-completion
tw-stock completion --cleanup # Remove completion from shell profile

Screenshots

Search TSE Stock

Search OTC Stock

Search Multiple Stocks