mozyfin-cli
v0.2.21
Published
Human- and agent-friendly CLI for Vietnamese market data via Mozyfin/Antofin APIs.
Maintainers
Readme
Mozyfin CLI
Mozyfin CLI brings Vietnamese market data and Mozyfin research workflows to your terminal. It is built for fast lookup, repeatable analysis, and agent-friendly command usage without exposing product internals.
Why Mozyfin CLI
- Fast market lookup — search symbols, view profiles, read news, and inspect company data from one command line.
- Agent-friendly — concise commands and predictable text output work well with Claude Code, Codex, GitHub Copilot, and other coding agents.
- Research-ready — ask natural-language questions, query documents, and export larger tables to CSV when needed.
- Terminal-native — use it manually, inside scripts, or as part of an agent workflow.
Requirements
- A Mozyfin API key for authenticated features
Create or manage your API key at:
https://research.mozyfin.com/settingsInstallation
npm install -g mozyfin-cli
mozyfin --helpOr with Bun:
bun install -g mozyfin-cli
mozyfin --helpLogin
Save your API key once:
mozyfin login --api-key mozy_ak_xxxYou can also use an environment variable:
export MOZYFIN_API_KEY=mozy_ak_xxxQuick Start
mozyfin search --query VNM
mozyfin profile VNM.VN
mozyfin news --entities VNM.VN --topics stock,earning --limit 10
mozyfin ohlcv VNM.VN --timeframe 1d --limit 200
mozyfin financials VNM.VN --year 2024 --quarter 4
mozyfin doc "định giá HPG"
mozyfin ask "compare VNM and MSN margin trend"Using With Coding Agents
Mozyfin CLI is a good fit for agent workflows because agents can call small terminal commands instead of loading large tool schemas or internal implementation details.
Install the Mozyfin skill so your agent knows the recommended commands and workflows:
mozyfin skill claude
mozyfin skill codex
mozyfin skill copilotSupported agents:
claude, cursor, copilot, windsurf, codex, gemini, hermes, openclaw, antigravityUseful skill commands:
mozyfin skill --list # show supported agents and install status
mozyfin skill <agent> # install or refresh the skill for one agent
mozyfin skill all # install or refresh the skill for all supported agents
mozyfin skill <agent> --remove # remove the skill from one agent
mozyfin update --skill all # force-refresh installed skills after updatingExample prompt for your agent:
Use mozyfin-cli to research VNM.VN.
Start with `mozyfin --help`, then gather profile, news, financials, and recent candles.
Summarize the key risks and catalysts with command outputs as evidence.For larger tabular results, ask your agent to use CSV export:
mozyfin ohlcv VNM.VN --timeframe 1d --limit 200 --csv vnm.csvCommands
Account
mozyfin login --api-key <key>
mozyfin logout
mozyfin credits
mozyfin doctor
mozyfin updateDiscovery
mozyfin search --query VNM
mozyfin profile VNM.VN
mozyfin indicesNews And Research
mozyfin news --query "Vinamilk" --limit 10
mozyfin news --entities VNM.VN,MSN.VN --topics stock,earning --limit 20
mozyfin doc "định giá HPG"
mozyfin ask "summarize VNM risks and catalysts"Market Data
mozyfin ohlcv VNM.VN --timeframe 1d --limit 200
mozyfin quote VNM.VN --limit 10Supported candle timeframes:
1h, 1d, 1w, 1mo, 1yCompany Data
mozyfin officers VNM.VN
mozyfin subsidiary VNM.VN
mozyfin holder VNM.VN --is-organization true
mozyfin holder-tx VNM.VN --transaction-type buy --limit 100Financials And Analytics
mozyfin financials VNM.VN --year 2024 --quarter 4
mozyfin stats VNM.VN --year 2024
mozyfin ta VNM.VN --sma 20,50 --rsi 14 --macd
mozyfin risk VNM.VN --limit 252 --risk-free 0.03Output
Mozyfin CLI prints readable text by default, usually Markdown tables or compact key-value sections.
mozyfin search --query VNM| symbol | name | exchange | market_cap | id |
| --- | --- | --- | --- | --- |
| VNM | Vietnam Dairy Products Joint Stock Company | HOSE | ... | VNM.VN |Use CSV when you want to save or process larger datasets:
mozyfin ohlcv VNM.VN --timeframe 1d --limit 200 --csv vnm.csvTips
- Use
mozyfin search --query <text>first to find the right entity id. - Pass ids like
VNM.VNinto detail commands. - Use
docfor document and report questions. - Use
askfor open-ended research prompts. - Keep prompts focused; run multiple commands for multi-part research.
Help
mozyfin --help
mozyfin <command> --help