8000 GitHub - drminh2807/vnstock-cli · GitHub
[go: up one dir, main page]

Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vnstock-cli

Unofficial command-line interface (CLI) for vnstock - Vietnam stock market data.

This project is a community-maintained wrapper and is not an official product of the vnstock author.
Source code: drminh2807/vnstock-cli

Installation

Using pipx (recommended)

pipx install vnstock-cli

Using pip

pip install vnstock-cli

Run without installing

pipx run vnstock-cli --help

Usage

Quote Commands

# Get historical price data
vnstock-cli quote history --symbol ACB --start 2024-01-01 --end 2024-12-31

# Get intraday data
vnstock-cli quote intraday --symbol ACB

# Get price depth (order book)
vnstock-cli quote depth --symbol ACB

Listing Commands

# List all symbols
vnstock-cli listing symbols

# List symbols by exchange
vnstock-cli listing symbols --exchange HOSE

# List indices
vnstock-cli listing indices --group VN30

# List industries
vnstock-cli listing industries

Company Commands

# Get company overview
vnstock-cli company overview --symbol ACB

# Get shareholders info
vnstock-cli company shareholders --symbol ACB

# Get company officers
vnstock-cli company officers --symbol ACB

Finance Commands

# Get balance sheet
vnstock-cli finance balance-sheet --symbol ACB --period year

# Get income statement
vnstock-cli finance income --symbol ACB

# Get cash flow statement
vnstock-cli finance cashflow --symbol ACB

# Get financial ratios
vnstock-cli finance ratio --symbol ACB

Trading Commands

# Get trading statistics
vnstock-cli trading stats --symbol ACB

# Get price board for multiple symbols
vnstock-cli trading board --symbols ACB,VCI,FPT

# Get foreign trading data
vnstock-cli trading foreign --symbol ACB

Misc Commands

# Get VCB exchange rates
vnstock-cli misc exchange-rate

# Get SJC gold prices
vnstock-cli misc gold-price

Output Formats

All commands support multiple output formats:

# Table format (default)
vnstock-cli quote history --symbol ACB --format table

# JSON format (for piping)
vnstock-cli quote history --symbol ACB --format json

# CSV format (for export)
vnstock-cli quote history --symbol ACB --format csv

Global Options

  • --source: Data source (VCI, TCBS, KBS, MSN). Default: KBS
  • --format: Output format (table, json, csv). Default: table
  • --quiet: Suppress progress output

Data Sources

  • KBS (KB Securities): Default source, reliable for Vietnamese stocks
  • VCI (Vietcap Securities): Alternative source
  • TCBS (Techcombank Securities): Includes screener functionality
  • MSN (Microsoft Network): For international markets (Forex, Crypto)

License

MIT License (unofficial CLI wrapper; underlying data and APIs are provided by the vnstock library).

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0