Skip to main content

Vietnamese stock market data & analysis library

Project description

claude-finance-kit

Vietnamese stock market analysis toolkit for AI coding assistants.
Fundamentals • Technicals • Macro • News • Screening • Fund Analysis

PyPI Version npm Version Python Versions License


Overview

claude-finance-kit is a Python library + AI plugin that gives your coding assistant deep access to Vietnamese stock market data and analysis tools. It works as a Claude Code plugin (via Marketplace), and also supports Cursor and GitHub Copilot through a CLI installer.

Ask natural language questions — the plugin auto-routes to the right analysis workflow:

"Analyze FPT stock"
"Market overview today"
"Compare VNM vs MSN"
"Latest news sentiment for HPG"

Example: Stock Analysis in Action

Claude Finance Kit analyzing HPG stock
Claude Code analyzing HPG stock — orchestrating fundamental and technical agents in parallel. Download plugin →

Features

  • Stock Analysis — valuation, financial health, technical indicators, screening, sentiment, sector analysis
  • Market Research — market valuation (P/E, P/B), sector comparison, fund analysis, commodities
  • Technical Analysis — 30+ indicators: SMA, EMA, RSI, MACD, Bollinger Bands, ATR, OBV, and more
  • Macro Research — GDP, CPI, interest rates, exchange rates, FDI, trade balance
  • News & Sentiment — crawl and classify news from Vietnamese financial sites (CafeF, VnExpress, etc.)
  • Fund Analysis — 58+ mutual funds: NAV, holdings, industry allocation, performance
  • Batch Collection — scheduled OHLCV, financial, and intraday data collection tasks
  • Multi-Source — automatic fallback across 12 data providers

Installation

1. Install the Python library

pip install claude-finance-kit

2. Install the AI plugin

Claude Code (via Marketplace)

Add the marketplace:

/plugin marketplace add hongbietcode/claude-finance-kit

Browse and install:

Run /plugin to open the plugin manager. Go to the Discover tab to find claude-finance-kit.

Select it and choose an installation scope:

  • User scope — available across all projects
  • Project scope — available for all collaborators on this repository
  • Local scope — available only for you in this repository

Or install directly:

/plugin install claude-finance-kit@hongbietcode-claude-finance-kit

Run /reload-plugins to activate.

Other AI Assistants (Cursor, Copilot)
npx claude-finance-kit-cli init --ai cursor    # Cursor
npx claude-finance-kit-cli init --ai copilot   # GitHub Copilot
npx claude-finance-kit-cli init --ai claude    # Claude Code (CLI alternative)

Quick Start

Once installed, just ask naturally — the plugin auto-invokes the right skill:

"Analyze FPT stock"                                        → stock-analysis
"Market overview today"                                    → market-research
"Compare VNM vs MSN"                                       → stock-analysis (comparative)
"Latest news sentiment for HPG"                            → news-sentiment
/marcus-vance "tôi mua HPG ở giá 26.6k, có nên bán không" → marcus-vance (full analysis)

Python Library Usage

from claude_finance_kit import Stock, Market, Macro, Commodity, Fund

# Stock data
stock = Stock("FPT")
stock.quote.history(start="2025-01-01", end="2025-12-31")
stock.finance.income_statement(period="quarter", lang="en")
stock.company.overview()

# Market valuation
market = Market("VNINDEX")
market.pe(duration="5Y")
market.top_gainer(limit=10)

# Macro indicators
macro = Macro()
macro.gdp()
macro.cpi()
macro.interest_rate()

# Commodities
commodity = Commodity()
commodity.gold()
commodity.oil()

# Fund analysis
fund = Fund()
fund.listing("STOCK")

Technical Analysis

from claude_finance_kit import Stock, Indicator

stock = Stock("FPT")
df = stock.quote.history(start="2025-01-01", end="2025-12-31")
df = df.set_index("time")

ind = Indicator(df)
ind.trend.sma(length=20)
ind.trend.ema(length=50)
ind.momentum.rsi(length=14)
ind.momentum.macd(fast=12, slow=26, signal=9)
ind.volatility.atr(length=14)
ind.volume.obv()

Data Sources

Source Type Coverage
VCI Stock (default) Quote, company, finance, listing, trading — full VN coverage
KBS Stock (fallback) Same as VCI — full VN coverage
MAS Stock Quote, intraday, financials, price depth
TVS Stock Company overview only
VDS Stock Intraday only
FMP Stock (global) Quote, company, financials — requires FMP_API_KEY
BINANCE Crypto History, intraday, depth — no API key
VND Market P/E, P/B, top movers
MBK Macro GDP, CPI, interest rates, FDI, trade balance
FMARKET Fund Mutual fund data (58+ funds)
SPL Commodity Gold, oil, steel, gas, fertilizer, agricultural
Perplexity Search Web search — requires PERPLEXITY_API_KEY

Source fallback: If VCI returns 403 (common on cloud IPs), the library automatically falls back to KBS. You can also specify manually: Stock("FPT", source="KBS").

Plugin Architecture

src/claude_finance_kit/       # Python library (PyPI)
cli/                          # npm CLI installer (claude-finance-kit-cli)
├── assets/
│   ├── skills/               # marcus-vance, stock-analysis, market-research, news-sentiment
│   ├── agents/               # fundamental-analyst, technical-analyst, macro-researcher, lead-analyst
│   ├── references/           # API docs, methodology, patterns
│   └── templates/            # Platform configs (claude, cursor, copilot)
├── src/                      # CLI source code
└── dist/                     # Built CLI
.claude-plugin/               # Claude Marketplace manifest

Skills & Agents

Component Type Role
marcus-vance Skill Senior analyst — orchestrates workflows, routes by complexity
stock-analysis Skill Individual stock deep dive
market-research Skill Market-wide analysis
news-sentiment Skill News crawling + sentiment
lead-analyst Agent Synthesis for comparative analysis
fundamental-analyst Agent Financials, valuation, earnings
technical-analyst Agent Price trends, momentum, S/R levels
macro-researcher Agent GDP, CPI, rates, FX, commodities

Environment Variables

Variable Required Description
FMP_API_KEY Optional For global stock data via Financial Modeling Prep
PERPLEXITY_API_KEY Optional For web search via Perplexity API

Documentation

Guide Description
Getting Started Installation, quickstart, architecture
Stock Module Stock API with data models
Market Module Market valuation API
Macro Module Macro indicators API
Fund Module Fund analysis API
Commodity Module Commodity API
Technical Analysis TA indicators reference
Collector Module Collector tasks, scheduler
News Module News crawlers, sites
Advanced Topics Provider registry, error handling
Search Module Perplexity Search API

Development

cd cli
npm install
npm run build              # Build CLI TypeScript
npm run bump -- patch      # Bump version (patch|minor|major)

Version Sync

npm run bump updates version across all files:

File Field
pyproject.toml version
src/claude_finance_kit/__init__.py __version__
cli/package.json version
.claude-plugin/plugin.json version
.claude-plugin/marketplace.json metadata.version + plugins[0].version

Publishing

npm run bump -- patch
git commit -am "chore: bump version to X.Y.Z"
git tag vX.Y.Z
git push origin main --tags    # Triggers CI: PyPI + npm publish

Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/my-feature)
  3. Commit your changes (git commit -m 'feat: add my feature')
  4. Push to the branch (git push origin feat/my-feature)
  5. Open a Pull Request

License

MIT

Disclaimer

Reports generated by this toolkit are for reference only and do not constitute investment advice. You are responsible for your own capital allocation and risk management.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

claude_finance_kit-0.1.26.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

claude_finance_kit-0.1.26-py3-none-any.whl (131.8 kB view details)

Uploaded Python 3

File details

Details for the file claude_finance_kit-0.1.26.tar.gz.

File metadata

  • Download URL: claude_finance_kit-0.1.26.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for claude_finance_kit-0.1.26.tar.gz
Algorithm Hash digest
SHA256 1c647812874bd97c64df86b25482ec254e7062cda55605a1dc61a0a5bd3af6a1
MD5 41f5f7d68e1813569c8ef226f90defee
BLAKE2b-256 b9bc317cfd4816befe7de39c4d8325f20f73ea36442f3f5a3d6527556619d730

See more details on using hashes here.

Provenance

The following attestation bundles were made for claude_finance_kit-0.1.26.tar.gz:

Publisher: release.yml on hongbietcode/claude-finance-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file claude_finance_kit-0.1.26-py3-none-any.whl.

File metadata

File hashes

Hashes for claude_finance_kit-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 b4fada8ad2f86bb3b4d6edca98b5f9269be1d86b57d12a19c45df9b237ca767e
MD5 92aade598c27ac092f1ae9263c6332f5
BLAKE2b-256 0a85eec6d454d9bb49fcfb8989f93055bddf04c1ba889d9181f1647976c9ff8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for claude_finance_kit-0.1.26-py3-none-any.whl:

Publisher: release.yml on hongbietcode/claude-finance-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page