Tra cứu thông tin tham chiếu
Cập nhật lần cuối:
Thảo luậnMục lục
Unified UI
Kể từ phiên bản 4.0, Vnstock sử dụng kiến trúc Unified UI nhằm mang lại giao diện lập trình nhất quán và dễ sử dụng nhất. Dưới đây là tài liệu chính thức cho phiên bản mới.
Nhóm Reference cung cấp các công cụ để khám phá thị trường, từ việc liệt kê danh sách cổ phiếu, thành phần chỉ số đến việc tra cứu thông tin chi tiết của một doanh nghiệp.
1. Khởi tạo
from vnstock import Reference, show_api, show_doc
# Khởi tạo đối tượng Reference
ref = Reference()2. Tiện ích trợ giúp (Helpers)
Kiến trúc Unified UI cung cấp các hàm tiện ích vô cùng mạnh mẽ giúp bạn dễ dàng khám phá cấu trúc API và đọc tài liệu ngay trong môi trường code (đặc biệt hữu ích trên Jupyter/Colab).
# Xem toàn bộ cấu trúc API của thư viện vnstock
show_api()
# Khám phá danh sách các hàm bên trong một Domain (ví dụ: Reference)
show_api(ref)
# Đọc tài liệu hướng dẫn sử dụng của một hàm cụ thể
show_doc('Reference.company')3. Các lớp và phương thức chi tiết
A. Lớp equity (Cổ phiếu)
Cung cấp danh sách các mã cổ phiếu đang niêm yết và phân loại theo nhóm/ngành.
| Phương thức | Tham số | Mô tả |
|---|---|---|
list() | - | Liệt kê toàn bộ mã cổ phiếu niêm yết. |
list_by_industry() | - | Liệt kê cổ phiếu theo ngành (ICB). |
list_by_exchange() | - | Liệt kê cổ phiếu theo sàn (HOSE, HNX, UPCOM). |
list_by_group() | group='VN30' | Liệt kê cổ phiếu theo nhóm chỉ số/sàn. |
[!WARNING] Lưu ý về nguồn VCI: Nguồn dữ liệu VCI (
list_by_industry) rất đa dạng và chuyên sâu nhưng không ổn định trên môi trường Google Colab do các biện pháp bảo mật hạn chế bot của VCI. Nếu bạn sử dụng Colab, hệ thống sẽ tự động chuyển sang nguồn KBS.
Dữ liệu mẫu (list()):
| symbol | organ_name |
|---|---|
| VCB | Ngân hàng TMCP Ngoại thương Việt Nam |
| HPG | Tập đoàn Hòa Phát |
B. Lớp index (Chỉ số)
Quản lý danh sách các bộ chỉ số thị trường.
| Phương thức | Tham số | Mô tả |
|---|---|---|
list() | - | Danh sách tất cả các chỉ số (VNINDEX, VN30...). |
groups() | - | Danh sách các nhóm chỉ số hỗ trợ. |
members() | symbol | Danh sách các mã thành phần trong rổ chỉ số. |
Dữ liệu mẫu (list()):
| symbol | name | group | index_id |
|---|---|---|---|
| VN30 | VN30 | VN30 | 5 |
| VNINDEX | VNINDEX | HOSE | 1 |
C. Lớp company (Thông tin Doanh nghiệp)
Tra cứu hồ sơ chi tiết của một mã chứng khoán cụ thể.
# Tra cứu thông tin công ty VCB (Vietcombank)
ref.company("VCB").info()| Phương thức | Tham số | Mô tả |
|---|---|---|
info() | - | Tổng quan về doanh nghiệp (ngành, vốn hóa...). |
shareholders() | - | Danh sách cổ đông lớn. |
officers() | - | Ban lãnh đạo công ty. |
subsidiaries() | - | Các công ty con, công ty liên kết. |
ownership() | - | Cơ cấu sở hữu. |
insider_trading() | - | Lịch sử giao dịch nội bộ. |
capital_history() | - | Lịch sử thay đổi vốn. |
news() | - | Tin tức liên quan. |
events() | - | Các sự kiện doanh nghiệp (Cổ tức, đại hội...). |
D. Các nhóm tài sản khác
etf.list(): Danh sách các chứng chỉ quỹ ETF.futures.list(): Danh sách hợp đồng tương lai.warrant.list(): Danh sách chứng quyền.bond.list(): Danh sách trái phiếu doanh nghiệp & chính phủ.fund.list(): Danh sách các quỹ mở (Nguồn FMarket).
4. Tìm kiếm (Search)
Hỗ trợ tìm kiếm mã chứng khoán và thông tin tài sản toàn cầu.
| Phương thức | Tham số | Mô tả |
|---|---|---|
symbol() | query | Tìm kiếm mã chứng khoán theo từ khóa. |
info() | query | Tìm kiếm thông tin chi tiết tài sản. |
# Tìm kiếm các mã chứng khoán thuộc nhóm ngành ngân hàng
ref.search.symbol("Ngân hàng")Lưu ý
Các phương thức trong nhóm Reference hiện được cung cấp đầy đủ trong Bản cộng đồng. Nếu bạn có nhu cầu truy xuất dữ liệu với tần suất cao hoặc cần các dữ liệu có độ phân giải sâu hơn để hệ thống phân tích tự động, vui lòng tham khảo các tính năng nâng cao tại Bản tài trợ.
Thảo luận