{"id":15626214,"url":"https://github.com/thinh-vu/vnstock","last_synced_at":"2025-05-14T12:11:15.706Z","repository":{"id":62223619,"uuid":"464019991","full_name":"thinh-vu/vnstock","owner":"thinh-vu","description":"A beginner-friendly yet powerful Python toolkit for financial analysis and automation — built to make modern investing accessible to everyone","archived":false,"fork":false,"pushed_at":"2025-05-04T15:10:10.000Z","size":59315,"stargazers_count":798,"open_issues_count":7,"forks_count":175,"subscribers_count":47,"default_branch":"main","last_synced_at":"2025-05-04T15:22:18.194Z","etag":null,"topics":["data-extraction","quantitative-analysis","quantitative-finance","quantitative-trading","stock-market","stock-screener"],"latest_commit_sha":null,"homepage":"https://vnstocks.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thinh-vu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["thinh-vu"],"custom":["https://paypal.me/thinhvuphoto"]}},"created_at":"2022-02-27T02:44:34.000Z","updated_at":"2025-05-04T15:10:14.000Z","dependencies_parsed_at":"2023-10-19T09:45:47.854Z","dependency_job_id":"c9227c10-e5c8-4c87-81f2-90c222d9884c","html_url":"https://github.com/thinh-vu/vnstock","commit_stats":{"total_commits":245,"total_committers":6,"mean_commits":"40.833333333333336","dds":0.4897959183673469,"last_synced_commit":"f47538f52bb770a3c9b0cc02b9a9804504f1a870"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Fvnstock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Fvnstock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Fvnstock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Fvnstock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thinh-vu","download_url":"https://codeload.github.com/thinh-vu/vnstock/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254140763,"owners_count":22021219,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-extraction","quantitative-analysis","quantitative-finance","quantitative-trading","stock-market","stock-screener"],"created_at":"2024-10-03T10:11:25.765Z","updated_at":"2025-05-14T12:11:15.690Z","avatar_url":"https://github.com/thinh-vu.png","language":"Python","funding_links":["https://github.com/sponsors/thinh-vu","https://paypal.me/thinhvuphoto"],"categories":["Python Libraries"],"sub_categories":[],"readme":"# Vnstock - Giải pháp phân tích chứng khoán mở cho người Việt\n\n[![Vnstock Homepage](https://raw.githubusercontent.com/thinh-vu/vnstock/refs/heads/main/assets/images/vnstock-hero-banner.png)](https://vnstocks.com/)\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/vnstock?logoColor=brown\u0026style=flat\" alt=\"Version\"/\u003e\n    \u003cimg src=\"https://img.shields.io/github/last-commit/thinh-vu/vnstock?style=flat\" alt=\"Commit Badge\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-Custom%20License-red?style=flat\" alt=\"Custom License Badge\"/\u003e\n\u003c/div\u003e\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/vnstock/\"\u003e\n        \u003cimg src=\"https://img.shields.io/pypi/dm/vnstock?label=vnstock%20download\u0026style=flat\" alt=\"vnstock download badge\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/vnstock3/\"\u003e\n        \u003cimg src=\"https://img.shields.io/pypi/dm/vnstock3?label=vnstock3%20download\u0026style=flat\" alt=\"vnstock3 download badge\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003ca href=\"https://github.com/sponsors/thinh-vu\"\u003e\n        \u003cimg src=\"https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86\" alt=\"vnstock3 download badge\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n---\n\n\u003e ⚠️ **Note**: This document begins in 🇻🇳 Vietnamese for our local community.  \n\u003e 🌐 **English version available below** — scroll or use the TOC (top-right 🟰) to navigate.\n\n---\n\n# 🎤 Giới thiệu về Vnstock\n\n\u003e Chào mừng bạn đến với **Vnstock**, bộ giải pháp mã nguồn mở toàn diện cho phân tích và tự động hóa đầu tư chứng khoán.\n\nVới sứ mệnh **\"Mang dữ liệu chứng khoán và công cụ đầu tư đến gần hơn với tất cả mọi người\"**, Vnstock liên tục cải tiến, tích hợp những công nghệ hiện đại để không chỉ đáp ứng nhu cầu cơ bản về dữ liệu, mà còn giúp bạn xây dựng các giải pháp phân tích tài chính thông minh và linh hoạt hơn bao giờ hết.\n\n### 🚀 Tại sao chọn Vnstock?\n\n- **Hoàn toàn miễn phí \u0026 mã nguồn mở**: Dễ dàng truy cập và sử dụng, phù hợp với nhà đầu tư cá nhân, nhà phân tích, và cộng đồng nghiên cứu.\n- **Giải pháp Python toàn diện**: Các hàm chức năng thân thiện, dễ dàng tích hợp để xây dựng các công cụ phân tích, bot giao dịch tự động.\n- **Dữ liệu đa dạng, cập nhật liên tục**: Bao gồm cổ phiếu, chứng quyền, chỉ số thị trường, hợp đồng tương lai, trái phiếu, ngoại hối, crypto và nhiều hơn thế nữa.\n\nBạn chính là một phần quan trọng trong hành trình **chuyển đổi số thị trường tài chính Việt Nam**. Hãy cùng Vnstock tạo nên những thay đổi tích cực và hiệu quả!\n\n### 🤝 Tham gia cộng đồng cùng chúng tôi!\n\nTham gia ngay cộng đồng Vnstock để giao lưu, chia sẻ kinh nghiệm và cập nhật những tính năng mới nhất từ dự án:\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n  \u003ca href=\"https://www.facebook.com/groups/vnstock.official\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Tham%20gia%20cộng%20đồng-Vnstock-blue?style=for-the-badge\u0026logo=facebook\" alt=\"Tham gia cộng đồng Vnstock\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n# II. Các nhóm tính năng chính\n\n\u003e `Vnstock` giúp rút ngắn thời gian xử lý dữ liệu, hỗ trợ học tập, nghiên cứu và xây dựng hệ thống phân tích giao dịch tài chính một cách hiệu quả – không chỉ là một công cụ trích xuất dữ liệu, mà là nền tảng để phát triển giải pháp đầu tư cá nhân thông minh. Thư viện được thiết kế dễ dàng sử dụng và tích hợp vào các hệ thống phân tích, nghiên cứu, trang tổng quan, hoặc bot chứng khoán.\n\n1. **Truy xuất dữ liệu qua API đơn giản**  \n  Dễ dàng truy cập dữ liệu thông qua các hàm Python thân thiện, giúp tích hợp nhanh vào hệ thống phân tích tự động hoặc bot giao dịch.\n\n2. **Dữ liệu cổ phiếu**  \n  Giá cổ phiếu thời gian thực, dữ liệu lịch sử, chỉ số tài chính và thông tin doanh nghiệp của các mã niêm yết.\n\n3. **Bộ lọc cổ phiếu**  \n  Hỗ trợ lọc cổ phiếu theo tiêu chí tài chính, kỹ thuật hoặc thị trường để phục vụ phân tích.\n\n4. **Chỉ số thị trường (Index)**  \n  Theo dõi hiệu suất các chỉ số trong nước (VNIndex, HNXIndex, UPCOM) và một số chỉ số quốc tế.\n\n5. **Chứng quyền (CW)**  \n  Thông tin chứng quyền bao gồm giá, ngày đáo hạn, tổ chức phát hành và trạng thái thị trường.\n\n6. **Kim loại quý**  \n  Cập nhật giá vàng trong nước và thế giới.\n\n7. **Hợp đồng tương lai (Phái sinh)**  \n  Dữ liệu hợp đồng tương lai như VN30F và các kỳ hạn giao dịch.\n\n8. **Quỹ đầu tư (ETF \u0026 Quỹ mở)**  \n  Thông tin về danh mục, hiệu suất và các chỉ số liên quan của quỹ đầu tư.\n\n9. **Trái phiếu**  \n  Dữ liệu trái phiếu Chính phủ và doanh nghiệp bao gồm kỳ hạn, lãi suất và khối lượng giao dịch.\n\n10. **Ngoại hối (Forex)**  \n  Tỷ giá cập nhật theo thời gian thực của các cặp tiền tệ phổ biến.\n\n11. **Tiền điện tử (Crypto)**  \n  Giá cả và biến động thị trường của các loại tiền điện tử lớn.\n\n12. **Tin tức \u0026 sự kiện tài chính**  \n  Tự động cập nhật tin tức, công bố thông tin doanh nghiệp và lịch sự kiện thị trường.\n\n---\n\n# III. Tuyên bố miễn trừ trách nhiệm\n\n\u003e Dự án **Vnstock** được phát triển nhằm phục vụ **mục đích nghiên cứu và sử dụng cá nhân**. Dữ liệu cung cấp có thể không đầy đủ, không liên tục hoặc sai lệch so với thực tế, do đó không khuyến nghị **sử dụng cho mục đích giao dịch thực tế, thuật toán đầu tư, hoặc ra quyết định tài chính** khi bạn không hiểu rõ.\n\nCác tác giả **không chịu trách nhiệm đối với bất kỳ tổn thất hay thiệt hại nào** phát sinh từ việc sử dụng dữ liệu hoặc mã nguồn này, bao gồm nhưng không giới hạn: sai lệch dữ liệu, mất mát tài chính, hoặc sử dụng sai mục đích.\n\n**Vnstock không cung cấp tư vấn đầu tư hay tín hiệu giao dịch**. Người dùng hoàn toàn tự chịu trách nhiệm khi sử dụng dự án.\n\n---\n\n# IV. 🔑 Giấy phép sử dụng (License)\n\n`Vnstock` được phát hành theo giấy phép tuỳ chỉnh hướng đến cá nhân, không dành cho mục đích thương mại. Quyền sử dụng được quy định cụ thể trong [giấy phép](LICENSE.md) kèm theo. Nếu bạn hoặc tổ chức bạn đang làm việc muốn sử dụng Vnstock có thể liên hệ tác giả để hiểu rõ phạm vi sử dụng và được cấp phép chính thức.\n\nKhi sử dụng Vnstock trong dự án của mình, bạn cần trích dẫn thông tin về tác giả và dự án theo hướng dẫn của Vnstock.\n\n---\n\n# V. 🙏 Bạn đồng hành \u0026 tài trợ\n\n## Bạn đồng hành\n\nVnstock phát triển nhờ sự chung tay của cộng đồng những người yêu thích công nghệ và tài chính. Mỗi dòng code, mỗi bản sửa lỗi đều là minh chứng cho sự đóng góp quý giá của các bạn. Cảm ơn vì đã biến vnstock thành công cụ mạnh mẽ cho cộng đồng đầu tư Việt Nam!\n\n\u003ca href=\"https://github.com/thinh-vu/vnstock/graphs/contributors\"\u003e\n   \u003cimg src=\"https://contributors-img.web.app/image?repo=thinh-vu/vnstock\" width=\"800\"/\u003e\n\u003c/a\u003e\n\n## ❤️ Nhà tài trợ nổi bật\n\nTừ tận đáy lòng, Vnstock gửi lời tri ân sâu sắc đến những người đã tin tưởng và ủng hộ vnstock. Sự đóng góp của các bạn không chỉ là nguồn lực tài chính – mà còn là niềm tin, sự khích lệ và là động lực mạnh mẽ để chúng tôi tiếp tục phát triển, tối ưu hóa và lan tỏa công cụ này đến cộng đồng đầu tư Việt Nam. \n\nDù lớn hay nhỏ, mỗi sự hỗ trợ đều là một lời nhắc nhở rằng chúng tôi không đi một mình. Các bạn là những đối tác đồng hành, những người tiên phong chung tay kiến tạo một hệ sinh thái dữ liệu tài chính dễ tiếp cận và minh bạch hơn cho mọi nhà đầu tư. \n\n\u003cdiv style=\"display: flex; flex-wrap: wrap; gap: 10px;\"\u003e\n  \u003c!-- Present \u0026 Past sponsors --\u003e\n\u003ca href=\"https://github.com/Huytq82\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/68698802?s=100\u0026v=4\" width=\"60px\" alt=\"Huytq82\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/yellow1912\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/374134?s=100\u0026v=4\" width=\"60px\" alt=\"yellow1912\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/thaituankha\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/136249921?s=100\u0026v=4\" width=\"60px\" alt=\"thaituankha\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/huannguyen2606\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/207012732?s=100\u0026v=4\" width=\"60px\" alt=\"huannguyen2606\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hungson175\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/565789?s=100\u0026v=4\" width=\"60px\" alt=\"hungson175\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/kynnbreak\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/60998063?s=100\u0026v=4\" width=\"60px\" alt=\"kynnbreak\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/quanglaife\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/153795419?s=100\u0026v=4\" width=\"60px\" alt=\"quanglaife\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/itkennylee\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/206494183?s=100\u0026v=4\" width=\"60px\" alt=\"itkennylee\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/congnt91\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/191594462?s=100\u0026v=4\" width=\"60px\" alt=\"congnt91\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/NATien1999\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/155497138?s=100\u0026v=4\" width=\"60px\" alt=\"NATien1999\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/khanhnl2806\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/202572860?s=100\u0026v=4\" width=\"60px\" alt=\"khanhnl2806\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Namdo1402\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/205231143?s=100\u0026v=4\" width=\"60px\" alt=\"Namdo1402\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/VNNTNAM\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/199906888?s=100\u0026v=4\" width=\"60px\" alt=\"VNNTNAM\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/NguyenNgocHuyhub\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/174630720?s=100\u0026v=4\" width=\"60px\" alt=\"NguyenNgocHuyhub\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/quy0193\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/90856171?s=100\u0026v=4\" width=\"60px\" alt=\"quy0193\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hieuvoquang87\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8354819?s=100\u0026v=4\" width=\"60px\" alt=\"hieuvoquang87\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/DrDinhLuong\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/86107710?s=100\u0026v=4\" width=\"60px\" alt=\"DrDinhLuong\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hphuongdhsp\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/37414457?s=100\u0026v=4\" width=\"60px\" alt=\"hphuongdhsp\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/dnambinh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/91754083?s=100\u0026v=4\" width=\"60px\" alt=\"dnambinh\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/tuanhung0804\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/59684986?s=100\u0026v=4\" width=\"60px\" alt=\"tuanhung0804\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ducdv2018\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/113516668?s=100\u0026v=4\" width=\"60px\" alt=\"ducdv2018\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ngohonglinh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/41242183?s=100\u0026v=4\" width=\"60px\" alt=\"ngohonglinh\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/cutuananh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/6285586?s=100\u0026v=4\" width=\"60px\" alt=\"cutuananh\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ThomasNguyen-git\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/182118805?s=100\u0026v=4\" width=\"60px\" alt=\"ThomasNguyen-git\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/lamquangphuc\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/454179?s=100\u0026v=4\" width=\"60px\" alt=\"lamquangphuc\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/nguyenquangtrung8\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/170158913?s=100\u0026v=4\" width=\"60px\" alt=\"nguyenquangtrung8\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/toramidu\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/98959140?s=100\u0026v=4\" width=\"60px\" alt=\"toramidu\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Hỗ trợ dự án\n\nNếu vnstock đã mang lại giá trị cho bạn và bạn muốn trở thành một phần của cộng đồng những người ủng hộ, sự đóng góp của bạn sẽ là nguồn động lực vô cùng to lớn đối với chúng tôi. Mỗi nhà tài trợ giúp chúng tôi có thêm thời gian cải thiện tài liệu, phát triển tính năng mới và duy trì sự bền vững lâu dài cho dự án này.\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003ca href=\"https://github.com/sponsors/thinh-vu\"\u003e\n        \u003cimg src=\"https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86\" alt=\"vnstock3 download badge\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n# VI. Lịch sử lượt yêu thích\n\nBạn có thể hỗ trợ dự án bằng cách cực kỳ đơn giản là đánh dấu yêu thích để giúp dự án có thể tiếp cận tới nhiều người hơn. Dưới đây là lịch sử lượt yêu thích của dự án.\n\n[![Star History Chart](https://api.star-history.com/svg?repos=thinh-vu/vnstock\u0026type=Date)](https://www.star-history.com/#thinh-vu/vnstock\u0026Date)\n\n\n# VII. ⏱️ Cập nhật đáng chú ý\n- 20-03-2025: Ra mắt phiên bản Vnstock `3.2.0` bổ sung thêm tính năng truy xuất dữ liệu Bộ lọc cổ phiếu.\n- 02-01-2025: Vnstock3 chính thức sử dụng tên nhận diện gói thư viện là vnstock tại trang phân phối chính thức pypi.org. Chi tiết [tại đây](https://vnstocks.com/blog/chuyen-doi-sang-vnstock3-truoc-2025)\n- 02-11-2024: Ra mắt Vnstock3 phiên bản 3.0.9. Chi tiết: [tại đây](https://vnstocks.com/docs/tai-lieu/lich-su-phien-ban#02-11-2024)\n- 10-05-2024: Ra mắt phiên bản Vnstock `3.0.1` với tên gói cài đặt `vnstock3`\n\n\u003e Chi tiết cập nhật phần mềm và phiên bản [tại đây](https://vnstocks.com/docs/tai-lieu/lich-su-phien-ban)\n\n---\n\n# VIII. 📔 Tài liệu hướng dẫn\n\nTrước khi bắt đầu, hãy đánh dấu yêu thích để giúp dự án có thể tiếp cận tới nhiều người hơn. Cám ơn bạn!\n\n![star_project](https://raw.githubusercontent.com/thinh-vu/vnstock/beta/docs/docs/assets/images/github_star_guide.png)\n\nĐể hiểu rõ hơn về vnstock và hướng dẫn sử dụng toàn diện, bạn có thể truy cập [vnstocks.com](https://vnstocks.com/docs/category/s%E1%BB%95-tay-h%C6%B0%E1%BB%9Bng-d%E1%BA%ABn). \n\nXem minh hoạ các tính năng thông qua Colab Notebook sau:\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n  \u003ca href=\"https://vnstocks.com/docs/tai-lieu/huong-dan-nhanh\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Tài%20liệu%20hướng%20dẫn-Vnstock-blue?style=for-the-badge\u0026logo=book\" alt=\"Tài liệu hướng dẫn Vnstock Badge\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## 8.1. Cài đặt \n\nBạn có thể cài đặt thư viện bản phát hành ổn định qua PyPI với câu lệnh sau:\n\n```bash\npip install -U vnstock\n```\n\nBạn cũng có thể cài đặt bản phát hành thử nghiệm trên Github với câu lệnh:\n\n```bash\npip install git+https://github.com/thinh-vu/vnstock.git\n```\n\n## 8.2. Nạp thư viện\n\nBạn cần nạp thư viện vào môi trường Python thông qua giao diện Jupyter Notebook hoặc Terminal để có thể gọi và sử dụng các hàm được cung cấp.\n\nCó 4 cách nạp thư viện vào môi trường làm việc như sau:\n\n### 8.2.1. Nạp thông qua giao diện làm việc chính\n\nGiao diện làm việc chính cho phép chuyển đổi nguồn và chỉ cần khai báo tên mã khi khởi động. Cấu trúc này phù hợp khi phân tích xuyên suốt 1 mã chứng khoán và nguồn dữ liệu đồng thời giúp tăng độ ổn định của mã nguồn trong tương lai khi các nguồn dữ mới được bổ sung hoặc nguồn cũ hết hiệu lực, bạn chỉ cần đổi tên nguồn để tiếp tục sử dụng.\n\n```\nfrom vnstock import Vnstock\nstock = Vnstock().stock(symbol='VCI', source='VCI')\nstock.quote.history(start='2020-01-01', end='2024-05-25')\n```\n\n### 8.2.2. Nạp thông qua các class tổng hợp\n\nBạn chọn nạp một trong các lớp chức năng chính. Các lớp chức năng này cho phép chuyển đổi dễ dàng nguồn dữ liệu được hỗ trợ trong khi giữ nguyên cấu trúc hàm. Cấu trúc này giúp tăng độ ổn định của mã nguồn trong tương lai khi các nguồn dữ mới được bổ sung hoặc nguồn cũ hết hiệu lực, bạn chỉ cần đổi tên nguồn để tiếp tục sử dụng.\n\n```python\nfrom vnstock import Listing, Quote, Company, Finance, Trading, Screener \n```\n\n### 8.2.3. Nạp các lớp tính năng riêng lẻ theo nguồn dữ liệu cố định\n\n\u003e Bạn cần tham khảo [mã nguồn](https://github.com/thinh-vu/vnstock/tree/main/vnstock/explorer) để sử dụng đúng các chức năng có sẵn trong thư viện.\n\n```python\nfrom vnstock.explorer.vci import Listing, Quote, Company, Finance, Trading\n```\n\nhoặc \n\n```python\nfrom vnstock.explorer.tcbs import Quote, Company, Finance, Trading, Screener\n```\n\n## 8.3. Danh sách niêm yết\n\n\u003e Danh sách các mã chứng khoán sử dụng trong việc thiết lập vòng lặp truy xuất dữ liệu từ các chức năng khác như Giá lịch sử, Thông tin công ty, Báo cáo tài chính, vv\n\n```python\nfrom vnstock import Listing\nlisting = Listing()\nlisting.all_symbols()\n```\n\n## 8.7. Giá lịch sử \u0026 thống kê giao dịch\n\n### Giá lịch sử\n\n```python\nfrom vnstock import Vnstock\nstock = Vnstock().stock(symbol='ACB', source='VCI')\nstock.quote.history(start='2024-01-01', end='2025-03-19', interval='1D')\n```\n\nhoặc\n\n```python\nfrom vnstock import Quote\nquote = Quote(symbol='ACB', source='VCI')\nquote.history(start='2024-01-01', end='2025-03-19', interval='1D')\n```\n\n### 8.5. Intraday\n\n\u003e Dữ liệu giao dịch khớp lệnh theo từng tick\n\n```python\nstock.quote.intraday(symbol='ACB', page_size=10_000, show_log=False)\n```\n\nChi tiết vui lòng tham khảo tài liệu và Demo Notebook.\n\n## 5.6. Bảng giá giao dịch\n\n```python\nfrom vnstock import Trading\nTrading(source='VCI').price_board(['VCB','ACB','TCB','BID'])\n```\n\n## 8.7. Truy xuất thông tin công ty\n\n```python\nfrom vnstock import Vnstock\ncompany = Vnstock().stock(symbol='ACB', source='VCI').company\ncompany.overview()\n```\n\nhoặc\n\n```python\nfrom vnstock import Company\ncompany = Company(symbol='ACB', source='VCI')\ncompany.overview()\n```\n\n## 8.8. Truy xuất báo cáo tài chính\n\n```python\nfrom vnstock import Vnstock\nstock = Vnstock().stock(symbol='VCI', source='VCI')\n# Bảng cân đối kế toán - năm\nstock.finance.balance_sheet(period='year', lang='vi', dropna=True)\n# Bảng cân đối kế toán - quý\nstock.finance.balance_sheet(period='quarter', lang='en', dropna=True)\n# Kết quả hoạt động kinh doanh\nstock.finance.income_statement(period='year', lang='vi', dropna=True)\n# Lưu chuyển tiền tệ\nstock.finance.cash_flow(period='year', dropna=True)\n# Chỉ số tài chính\nstock.finance.ratio(period='year', lang='vi', dropna=True)\n```\n\n## 8.9. Bộ lọc cổ phiếu\n\n```python\nfrom vnstock import Screener\nstock.screener.stock(params={\"exchangeName\": \"HOSE,HNX,UPCOM\"}, limit=1700)\n```\n\n## 8.10. Dữ liệu quỹ mở\n\n```python\nfrom vnstock.explorer.fmarket.fund import Fund\nfund = Fund()\nfund.listing()\n```\n\n## 8.11. Dữ liệu thị trường quốc tế: Cổ phiếu, FX, Index\n\n```python\nfrom vnstock import Vnstock\nfx = Vnstock().fx(symbol='JPYVND', source='MSN')\ndf = fx.quote.history(start='2025-01-02', end='2025-03-20', interval='1D')\ndf\n```\n\n## 8.12. Tỷ giá \u0026 giá vàng\n\n```python\nfrom vnstock.explorer.misc import *\n\n# Tỷ giá ngoại tệ VCB\nvcb_exchange_rate(date='2024-03-21')\n\n# Giá vàng SJC\nsjc_gold_price()\n```\n\n## 8.13. Xuất dữ liệu\n\n\u003e Tất cả dữ liệu trả về từ Vnstock đều là Pandas DataFrame hoặc Series, do đó, bạn có thể mô hình hoá các thao tác phân tích của mình với lệnh Python dễ dàng nhờ hỗ trợ của AI. Nếu cần xuất dữ liệu sang các định dạng truyền thống, bạn chỉ cần gán các hàm mô tả ở trên với 1 tên biến và thực hiện xuất dữ liệu như dưới đây:\n\n```python\n# Biến ratio_df lưu giá trị của phép tính vào bộ nhớ\nratio_df = stock.finance.ratio(period='year', lang='vi', dropna=True)\n\n# Xuất dữ liệu ra Excel\nratio_df.to_excel('/nơi_lưu_file_của_bạn/tên_file-ratio_df.xlsx`, index=False')\n# Xuất dữ liệu ra CSV\nratio_df.to_csv('/nơi_lưu_file_của_bạn/tên_file-ratio_df.csv`, index=False')\n```\n\n---\n\n# Vnstock - The Open-Source Stock Analysis Toolkit for Investors in Vietnam\n\n[![Vnstock Homepage](https://raw.githubusercontent.com/thinh-vu/vnstock/refs/heads/main/assets/images/vnstock-hero-banner.png)](https://vnstocks.com/)\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/vnstock?logoColor=brown\u0026style=flat\" alt=\"Version\"/\u003e\n    \u003cimg src=\"https://img.shields.io/github/last-commit/thinh-vu/vnstock?style=flat\" alt=\"Commit Badge\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-Custom%20License-red?style=flat\" alt=\"Custom License Badge\"/\u003e\n\u003c/div\u003e\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/vnstock/\"\u003e\n        \u003cimg src=\"https://img.shields.io/pypi/dm/vnstock?label=vnstock%20download\u0026style=flat\" alt=\"vnstock download badge\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/vnstock3/\"\u003e\n        \u003cimg src=\"https://img.shields.io/pypi/dm/vnstock3?label=vnstock3%20download\u0026style=flat\" alt=\"vnstock3 download badge\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n# 🎤 Introduction to Vnstock\n\n\u003e Welcome to **Vnstock**, a comprehensive open-source solution for stock analysis and investment automation in Vietnam.\n\nDriven by the mission **\"To bring financial data and investment tools closer to everyone\"**, Vnstock continuously evolves by integrating modern technologies—not only meeting basic data needs but also empowering you to build flexible, intelligent financial analysis solutions.\n\n### 🚀 Why Vnstock?\n\n- **Free \u0026 Open-Source**: Accessible for all—investors, analysts, researchers, and educators.\n- **Full-Stack Python Support**: Easy-to-use functions for building analysis tools or automated trading bots.\n- **Diverse, Continuously Updated Data**: Covers stocks, warrants, indices, futures, bonds, forex, crypto, and more.\n\nYou are an important part of the **digital transformation of Vietnam’s financial market**. Let’s create impact together with Vnstock!\n\n### 🤝 Join the Community\n\nJoin the Vnstock community to share knowledge, collaborate, and stay updated with the latest features:\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n  \u003ca href=\"https://www.facebook.com/groups/vnstock.official\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Join%20the%20Community-Vnstock-blue?style=for-the-badge\u0026logo=facebook\" alt=\"Join Vnstock Community\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n# II. Key Feature Groups\n\n\u003e `Vnstock` reduces time-to-insight by streamlining data processing, enabling learners, researchers, and financial analysts to build their own smart investment solutions. It is more than a data extraction tool—it’s a flexible foundation for personal investing systems.\n\n1. **Easy API Access**  \n   Retrieve financial data through simple and intuitive Python functions.\n\n2. **Stock Data**  \n   Real-time prices, historical prices, financial indicators, and company profiles for listed stocks.\n\n3. **Stock Screener**  \n   Filter stocks based on financial, technical, or market criteria.\n\n4. **Market Indices**  \n   Track performance of Vietnamese indices (VNIndex, HNX, UPCOM) and select global indices.\n\n5. **Covered Warrants (CW)**  \n   Includes price, expiration, issuers, and market status of warrants.\n\n6. **Precious Metals**  \n   Domestic and international gold price updates.\n\n7. **Futures Contracts**  \n   Derivatives like VN30F and other trading terms.\n\n8. **Investment Funds (ETF \u0026 Mutual Funds)**  \n   Portfolio composition, performance, and key metrics.\n\n9. **Bonds**  \n   Government and corporate bond data, including yield, maturity, and volume.\n\n10. **Forex**  \n    Real-time exchange rates for major currency pairs.\n\n11. **Cryptocurrencies**  \n    Prices and market volatility for top cryptocurrencies.\n\n12. **Financial News \u0026 Events**  \n    Auto-updated financial news, disclosures, and market events calendar.\n\n---\n\n# III. Disclaimer\n\n\u003e **Vnstock** is developed for **personal and research use only**. The provided data may be incomplete, inconsistent, or inaccurate, and should not be used for **live trading, algorithmic strategies, or financial decisions** without proper due diligence.\n\nThe authors **disclaim all responsibility** for any loss, damage, or financial risk arising from the use of this library, including but not limited to: data errors, misinterpretation, or misuse.\n\n**Vnstock does not offer investment advice or trading signals**. Users bear full responsibility for how they use this project.\n\n---\n\n# IV. 🔑 License\n\n`Vnstock` is distributed under a custom license focused on **personal, non-commercial use**. Usage terms are detailed in the [LICENSE](LICENSE.md). For commercial or institutional use, please contact the author for official licensing.\n\nWhen using Vnstock in your project, you are required to cite the author and project as per the citation guide provided.\n\n---\n\n# V. 🙏 Contributors \u0026 Sponsors\n\n## Contributors \n\nVnstock thrives thanks to the collective efforts of tech and finance enthusiasts. Every line of code and every bug fix reflects your valuable contributions. Thank you for making vnstock a powerful tool for the investment community!\n\n\u003ca href=\"https://github.com/thinh-vu/vnstock/graphs/contributors\"\u003e\n   \u003cimg src=\"https://contributors-img.web.app/image?repo=thinh-vu/vnstock\" width=\"800\"/\u003e\n\u003c/a\u003e\n\n## ❤️ Featured Sponsors\n\nFrom the bottom of our hearts, we want to express our deepest gratitude to all our incredible sponsors. Your generous support has been the backbone of this project, allowing us to dedicate more time and resources to improving vnstock. Each contribution, regardless of size, fuels our passion and helps us maintain and enhance this open-source tool for the entire investment community. You are not just sponsors – you are essential partners in our journey to democratize financial data access for all investors.\n\n\u003cdiv style=\"display: flex; flex-wrap: wrap; gap: 10px;\"\u003e\n  \u003c!-- Present \u0026 Past sponsors --\u003e\n\u003ca href=\"https://github.com/Huytq82\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/68698802?s=100\u0026v=4\" width=\"60px\" alt=\"Huytq82\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/yellow1912\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/374134?s=100\u0026v=4\" width=\"60px\" alt=\"yellow1912\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/thaituankha\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/136249921?s=100\u0026v=4\" width=\"60px\" alt=\"thaituankha\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/huannguyen2606\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/207012732?s=100\u0026v=4\" width=\"60px\" alt=\"huannguyen2606\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hungson175\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/565789?s=100\u0026v=4\" width=\"60px\" alt=\"hungson175\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/kynnbreak\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/60998063?s=100\u0026v=4\" width=\"60px\" alt=\"kynnbreak\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/quanglaife\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/153795419?s=100\u0026v=4\" width=\"60px\" alt=\"quanglaife\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/itkennylee\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/206494183?s=100\u0026v=4\" width=\"60px\" alt=\"itkennylee\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/congnt91\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/191594462?s=100\u0026v=4\" width=\"60px\" alt=\"congnt91\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/NATien1999\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/155497138?s=100\u0026v=4\" width=\"60px\" alt=\"NATien1999\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/khanhnl2806\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/202572860?s=100\u0026v=4\" width=\"60px\" alt=\"khanhnl2806\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Namdo1402\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/205231143?s=100\u0026v=4\" width=\"60px\" alt=\"Namdo1402\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/VNNTNAM\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/199906888?s=100\u0026v=4\" width=\"60px\" alt=\"VNNTNAM\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/NguyenNgocHuyhub\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/174630720?s=100\u0026v=4\" width=\"60px\" alt=\"NguyenNgocHuyhub\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/quy0193\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/90856171?s=100\u0026v=4\" width=\"60px\" alt=\"quy0193\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hieuvoquang87\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8354819?s=100\u0026v=4\" width=\"60px\" alt=\"hieuvoquang87\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/DrDinhLuong\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/86107710?s=100\u0026v=4\" width=\"60px\" alt=\"DrDinhLuong\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hphuongdhsp\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/37414457?s=100\u0026v=4\" width=\"60px\" alt=\"hphuongdhsp\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/dnambinh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/91754083?s=100\u0026v=4\" width=\"60px\" alt=\"dnambinh\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/tuanhung0804\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/59684986?s=100\u0026v=4\" width=\"60px\" alt=\"tuanhung0804\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ducdv2018\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/113516668?s=100\u0026v=4\" width=\"60px\" alt=\"ducdv2018\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ngohonglinh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/41242183?s=100\u0026v=4\" width=\"60px\" alt=\"ngohonglinh\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/cutuananh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/6285586?s=100\u0026v=4\" width=\"60px\" alt=\"cutuananh\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ThomasNguyen-git\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/182118805?s=100\u0026v=4\" width=\"60px\" alt=\"ThomasNguyen-git\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/lamquangphuc\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/454179?s=100\u0026v=4\" width=\"60px\" alt=\"lamquangphuc\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/nguyenquangtrung8\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/170158913?s=100\u0026v=4\" width=\"60px\" alt=\"nguyenquangtrung8\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/toramidu\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/98959140?s=100\u0026v=4\" width=\"60px\" alt=\"toramidu\" style=\"border-radius: 50%;\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n### Support the Project\n\nIf you've found value in vnstock and would like to join our community of supporters, your contribution would mean the world to us. Every sponsor enables us to dedicate more time to improving documentation, adding new features, and ensuring the long-term sustainability of this project.\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n    \u003ca href=\"https://github.com/sponsors/thinh-vu\"\u003e\n        \u003cimg src=\"https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86\" alt=\"vnstock3 download badge\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\n---\n\n# VI. Star History\n\nYou can support the project by simply starring it on GitHub—this helps the project reach more people. Here's the star history:\n\n[![Star History Chart](https://api.star-history.com/svg?repos=thinh-vu/vnstock\u0026type=Date)](https://www.star-history.com/#thinh-vu/vnstock\u0026Date)\n\n---\n\n# VII. ⏱️ Notable Updates\n\n- **20-Mar-2025**: Version `3.2.0` released with Stock Screener data access.\n- **02-Jan-2025**: Official package name for Vnstock3 updated to `vnstock` on PyPI. [Read more](https://vnstocks.com/blog/chuyen-doi-sang-vnstock3-truoc-2025)\n- **02-Nov-2024**: Vnstock3 version `3.0.9` released. [Details](https://vnstocks.com/docs/tai-lieu/lich-su-phien-ban#02-11-2024)\n- **10-May-2024**: Initial release of Vnstock `3.0.1` under package name `vnstock3`\n\n\u003e Full changelog available [here](https://vnstocks.com/docs/tai-lieu/lich-su-phien-ban)\n\n---\n\n# VII. 📔 Documentation\n\nBefore getting started, consider starring the project to support us—thank you!\n\n![star_project](https://raw.githubusercontent.com/thinh-vu/vnstock/beta/docs/docs/assets/images/github_star_guide.png)\n\nFull documentation and usage guide: [vnstocks.com/docs](https://vnstocks.com/docs/category/s%E1%BB%95-tay-h%C6%B0%E1%BB%9Bng-d%E1%BA%ABn)\n\nExample use cases in Colab Notebook:\n\n\u003cdiv id=\"badges\" align=\"center\"\u003e\n  \u003ca href=\"https://vnstocks.com/docs/tai-lieu/huong-dan-nhanh\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Quick%20Guide-Vnstock-blue?style=for-the-badge\u0026logo=book\" alt=\"Vnstock Docs Badge\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## 8.1 Installation\n\nInstall or upgrade to the latest version of Vnstock via pip:\n\n```bash\npip install -U vnstock\n```\n\nYou can also install the experimental release from GitHub using the command:\n\n```bash\npip install git+https://github.com/thinh-vu/vnstock.git\n```\n\n---\n\n## 8.2 Importing the Library\n\nYou can import Vnstock into your Python environment using Jupyter Notebook or any Python console. There are four supported methods:\n\n### 8.2.1. Import via Unified Interface\n\nThis is the primary method for loading the library, allowing you to define the data source once and reuse across functions. Ideal for analyzing a single stock with consistent settings:\n\n```python\nfrom vnstock import Vnstock\nstock = Vnstock().stock(symbol='VCI', source='VCI')\nstock.quote.history(start='2020-01-01', end='2024-05-25')\n```\n\n### 8.2.2. Import Main Functional Classes\n\nLoad from core modules that support dynamic switching between data providers:\n\n```python\nfrom vnstock import Listing, Quote, Company, Finance, Trading, Screener \n```\n\n### 8.2.3. Import from Specific Data Providers\n\nFor advanced users needing fixed data sources. Refer to the [source code](https://github.com/thinh-vu/vnstock/tree/main/vnstock/explorer) for details:\n\n```python\nfrom vnstock.explorer.vci import Listing, Quote, Company, Finance, Trading\n```\n\nor\n\n```python\nfrom vnstock.explorer.tcbs import Quote, Company, Finance, Trading, Screener\n```\n\n---\n\n## 8.3 Listing Symbols\n\nUsed for generating lists of available tickers—essential for batch operations:\n\n```python\nfrom vnstock import Listing\nlisting = Listing()\nlisting.all_symbols()\n```\n\n---\n\n## 8.4 Historical Prices \u0026 Trading Stats\n\n### Historical Prices\n\n```python\nfrom vnstock import Vnstock\nstock = Vnstock().stock(symbol='ACB', source='VCI')\nstock.quote.history(start='2024-01-01', end='2025-03-19', interval='1D')\n```\n\nOr use:\n\n```python\nfrom vnstock import Quote\nquote = Quote(symbol='ACB', source='VCI')\nquote.history(start='2024-01-01', end='2025-03-19', interval='1D')\n```\n\n---\n\n## 8.5 Intraday Tick Data\n\n\u003e Retrieves granular trade data per tick:\n\n```python\nstock.quote.intraday(symbol='ACB', page_size=10_000, show_log=False)\n```\n\n---\n\n## 8.6 Market Price Board\n\nGet real-time quotes for multiple tickers:\n\n```python\nfrom vnstock import Trading\nTrading(source='VCI').price_board(['VCB','ACB','TCB','BID'])\n```\n\n---\n\n## 8.7 Company Information\n\n```python\nfrom vnstock import Vnstock\ncompany = Vnstock().stock(symbol='ACB', source='VCI').company\ncompany.overview()\n```\n\nOr:\n\n```python\nfrom vnstock import Company\ncompany = Company(symbol='ACB', source='VCI')\ncompany.overview()\n```\n\n---\n\n## 8.8 Financial Reports\n\n```python\nfrom vnstock import Vnstock\nstock = Vnstock().stock(symbol='VCI', source='VCI')\n\n# Balance Sheet - yearly\nstock.finance.balance_sheet(period='year', lang='vi', dropna=True)\n\n# Balance Sheet - quarterly\nstock.finance.balance_sheet(period='quarter', lang='en', dropna=True)\n\n# Income Statement\nstock.finance.income_statement(period='year', lang='vi', dropna=True)\n\n# Cash Flow\nstock.finance.cash_flow(period='year', dropna=True)\n\n# Financial Ratios\nstock.finance.ratio(period='year', lang='vi', dropna=True)\n```\n\n---\n\n## 8.9 Stock Screener\n\n```python\nfrom vnstock import Screener\nstock.screener.stock(params={\"exchangeName\": \"HOSE,HNX,UPCOM\"}, limit=1700)\n```\n\n---\n\n## 8.10 Mutual Fund Data\n\n```python\nfrom vnstock.explorer.fmarket.fund import Fund\nfund = Fund()\nfund.listing()\n```\n\n---\n\n## 8.11 International Markets: Stocks, FX, Indices\n\n```python\nfrom vnstock import Vnstock\nfx = Vnstock().fx(symbol='JPYVND', source='MSN')\ndf = fx.quote.history(start='2025-01-02', end='2025-03-20', interval='1D')\ndf\n```\n\n---\n\n## 8.12 Exchange Rates \u0026 Gold Prices\n\n```python\nfrom vnstock.explorer.misc import *\n\n# VCB exchange rate\nvcb_exchange_rate(date='2024-03-21')\n\n# SJC gold price\nsjc_gold_price()\n```\n\n---\n\n## 8.13 Exporting Data\n\n\u003e All data from Vnstock is returned as Pandas `DataFrame` or `Series`, making it AI-friendly and easy to process or export.\n\n```python\n# Save ratio data to memory\nratio_df = stock.finance.ratio(period='year', lang='vi', dropna=True)\n\n# Export to Excel\nratio_df.to_excel('/your_save_path/ratio_df.xlsx', index=False)\n\n# Export to CSV\nratio_df.to_csv('/your_save_path/ratio_df.csv', index=False)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinh-vu%2Fvnstock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthinh-vu%2Fvnstock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinh-vu%2Fvnstock/lists"}