openstockapi · PyPI Skip to main content Switch to mobile version Warning Some features may not work without
JavaScript. Please try enabling it if you encounter problems. Search PyPI Search Help Docs Sponsors Log in Register Menu
Help Docs Sponsors Log in Register Search PyPI Search openstockapi 0.2.2 pip install openstockapi==0.2.2 Copy PIP
instructions Newer version available (0.2.3) Released: Jul 22, 2026 Vietnam stock market data library — open source
data plane Navigation Project description Release history Download files Verified details These details have been
verified by PyPI Maintainers openstockapi Unverified details These details have not been verified by PyPI Meta License:
GNU Affero General Public License v3 (AGPL-3.0-only) Author: Your Name Requires: Python >=3.10 Provides-Extra: pandas
, dev Classifiers License OSI Approved :: GNU Affero General Public License v3 Operating System OS Independent
Programming Language Python :: 3 Python :: 3.10 Python :: 3.11 Python :: 3.12 Report project as malware Project
description Project details Release history Download files Project description OpenStockAPI A modular, multi-source
Python Data Plane for Vietnamese & International financial market data. Read the Docs » · Report Bug ·
Request Feature 📋 Table of Contents About The Project Features Quick Start Installation Usage & Documentation
Supported Providers Data Modules Roadmap Contributing Changelog License About The Project OpenStockAPI is an open-source
Python library that acts as a modular Data Plane for collecting and standardizing financial data from multiple
Vietnamese and international sources. It is designed to be the upstream data acquisition layer for financial
applications — handling provider fallback, rate limiting, and tier-based access control — so your application logic
never has to worry about data source reliability. 📘 A Vietnamese version of this README is available: README_VN.md
(back to top ↑) Features ** Multi-market Support** — Covers Vietnamese (VN) equities and can be extended to
International (US) markets with the same API. ** Automatic Multi-source Fallback** — Integrates providers (KBS, VCI,
MSN, MAS, Maybank, Fmarket) with transparent automatic failover when any source is unavailable. ** Freemium Tier Access
Control** — Supports Free, Pro (200 req/min), and Premium (500 req/min) tiers with a client-side Token Bucket Rate
Limiter. ** Async Support** — First-class async/await support via async_ohlcv() for high-throughput data pipelines.
(back to top ↑) Quick Start import openstockapi as osapi # Initialize with your API key (required for all tiers) #
Register for free at: https://openstockapi.com/register osapi.init("free_YOUR_KEY") # or "pro_YOUR_KEY" /
"premium_YOUR_KEY" # Historical OHLCV price data df = osapi.ohlcv("VNM", resolution="1D", start="2025-01-01",
end="2025-12-31") print(df.head()) # Company financial statements bs = osapi.balance_sheet("VNM", period="annual") #
Realtime market quote quote = osapi.quote("HPG") print(f"{quote.symbol}: {quote.price:,.0f} VND
({quote.pct_change:+.2f}%)") # Corporate news & events news = osapi.company_news("FPT", limit=5) events =
osapi.company_events("FPT", limit=5) (back to top ↑) Installation Minimum install: pip install openstockapi With
Pandas DataFrame & Excel export support: pip install openstockapi[pandas] Requirements: Python 3.8+ (back to top
↑) Usage & Documentation Full documentation, use case examples, and sample outputs are available in the User
Guide: User Guide — Getting Started Module Description Guide 01 — OHLCV & Profile Historical price data, company
profile 02 — Financial Statements Balance sheet, income, cash flow, ratios 03 — Realtime Quote Live price, order
book depth 04 — Market Indices VNINDEX, VN30 constituents 05 — Macro Indicators CPI, M2 money supply, credit growth
06 — Mutual Funds Fund NAV, portfolio holdings 07 — News & Events Corporate news, dividends, events (back to top
↑) Supported Providers Provider Source Tier Data Types kbs KB Securities Vietnam Free OHLCV, Profile, News, Events vci
Vietcap Securities Free OHLCV, Profile, Financial Statements, Insider/Foreign/Prop Trading, Events msn MSN Finance
(Bing) Free OHLCV (VN & International) mas MAS (Mass Asset Securities) Free Financial Statements, Ratios mbk Maybank
Securities Vietnam Free Macro Indicators (M2, Credit) fmarket Fmarket Vietnam Free Mutual Fund NAV & Holdings tcbs
TCBS (Techcom Securities) Free Realtime Quote, Order Book Providers are tried in priority order per data type. If one
fails, the next is used automatically. (back to top ↑) Data Modules Overview openstockapi ├── ohlcv() #
Historical OHLCV (sync) ├── async_ohlcv() # Historical OHLCV (async) ├── profile() # Company profile
├── balance_sheet() # Balance sheet ├── income_statement() # Income statement ├── cashflow() # Cash
flow statement ├── ratios() # Financial ratios (PE, PB, ROE...) ├── quote() # Realtime price quote ├──
order_book() # Order book depth ├── market_index() # Market index OHLCV ├── index_constituents() # Index
member list ├── macro_indicators() # Macroeconomic data ├── fund_details() # Mutual fund info ├──
company_news() # Corporate news └── company_events() # Corporate events (dividends, ESOP...) (back to top ↑)
Roadmap Vietnamese equity OHLCV (KBS, VCI, MSN) Financial statements (MAS, VCI) Macroeconomic indicators (World Bank,
Maybank) Mutual fund data (Fmarket) Corporate news & events (KBS, VCI) International equity OHLCV Cryptocurrency
data Derivatives / Futures data WebSocket streaming quotes (back to top ↑) Contributing Contributions are welcome! If
you'd like to add a new provider, fix a bug, or improve documentation: Fork the repository Create a feature branch: git
checkout -b feature/new-provider Commit your changes Open a Pull Request (back to top ↑) Changelog See all version
updates, new features, and bug fixes at: CHANGELOG.md (back to top ↑) License Distributed under the GNU Affero General
Public License v3.0 (AGPL-3.0). See LICENSE for more information. (back to top ↑) Project details Verified details
These details have been verified by PyPI Maintainers openstockapi Unverified details These details have not been
verified by PyPI Meta License: GNU Affero General Public License v3 (AGPL-3.0-only) Author: Your Name Requires: Python
>=3.10 Provides-Extra: pandas , dev Classifiers License OSI Approved :: GNU Affero General Public License v3
Operating System OS Independent Programming Language Python :: 3 Python :: 3.10 Python :: 3.11 Python :: 3.12 Release
history Release notifications | RSS feed 0.2.3 Jul 22, 2026 This version 0.2.2 Jul 22, 2026 0.2.1 yanked Jul 22, 2026
0.2.0 yanked Jul 22, 2026 0.1.0 yanked Jul 20, 2026 Download files Download the file for your platform. If you're not
sure which to choose, learn more about installing packages. Source Distribution openstockapi-0.2.2.tar.gz (39.0 kB view
details) Uploaded Jul 22, 2026 Source Built Distribution Filter files by name, interpreter, ABI, and platform. If you're
not sure about the file name format, learn more about wheel file names. The dropdown lists show the available
interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files. Copy a direct link to
the current filters Copy File name Interpreter Interpreter py3 ABI ABI none Platform Platform any
openstockapi-0.2.2-py3-none-any.whl (50.1 kB view details) Uploaded Jul 22, 2026 Python 3 File details Details for the
file openstockapi-0.2.2.tar.gz. File metadata Download URL: openstockapi-0.2.2.tar.gz Upload date: Jul 22, 2026 Size:
39.0 kB Tags: Source Uploaded using Trusted Publishing? No Uploaded via: twine/6.2.0 CPython/3.11.9 File hashes Hashes
for openstockapi-0.2.2.tar.gz Algorithm Hash digest SHA256
4df6d61ed755b70900597febd81b1fb692b775c144c4d8078e9bcf6a4dee2fae Copy MD5 d051c9cbab3b8bd3f2fa9c10ab6c9c50 Copy
BLAKE2b-256 ed94f40167c1a81f37e5c7685da69b94902ccf2191060445131716e739530add Copy See more details on using hashes here.
File details Details for the file openstockapi-0.2.2-py3-none-any.whl. File metadata Download URL:
openstockapi-0.2.2-py3-none-any.whl Upload date: Jul 22, 2026 Size: 50.1 kB Tags: Python 3 Uploaded using Trusted
Publishing? No Uploaded via: twine/6.2.0 CPython/3.11.9 File hashes Hashes for openstockapi-0.2.2-py3-none-any.whl
Algorithm Hash digest SHA256 ffc70e440c4abbed0ff72f3dae1b5eef9a2b6dded2fafb067e17dac1368b2464 Copy MD5
b122eee802cf6fe0c8113f52307ce345 Copy BLAKE2b-256 68a3f57af77ba27e7b4481e7090c8b197621755eb137758cdb413f93ee916ed4 Copy
See more details on using hashes here. Help Installing packages Uploading packages User guide Project name retention
FAQs About PyPI PyPI Blog Infrastructure dashboard Statistics Logos & trademarks Our sponsors Contributing to PyPI Bugs
and feedback Contribute on GitHub Translate PyPI Sponsor PyPI Development credits Using PyPI Terms of Service Report
security issue Code of conduct Privacy Notice Acceptable Use Policy Status: all systems operational Developed and
maintained by the Python community, for the Python community. Donate today! "PyPI", "Python Package Index", and the
blocks logos are registered trademarks of the Python Software Foundation. © 2026 Python Software Foundation Site map
Deployed from 8dee359 Switch to desktop version English español français 日本語 português (Brasil)
українська Ελληνικά Deutsch 中文 (简体) 中文 (繁體) русский עברית Esperanto
한국어 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