Lớp Reference: hàm truy xuất dữ liệu tham chiếu
Mục lục
Bản mặc định hiện là vnstock v5.0.0, gộp bản Cộng đồng và bản Mở rộng vào một thư viện. Trang này giữ lại cho máy còn cài vnstock v4.x: mã viết theo trang này vẫn chạy với bản đó. Đã cài bản mới thì đọc trang tương ứng của v5.0.0.
Máy đang cài bản nào: chạy python -c "import vnstock; print(vnstock.__version__)", ra số bắt đầu bằng 5. là thế hệ 5.
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 ở bản Cộng đồng gồm các hàm tra cứu nền tảng. Nếu mô hình phân tích của bạn cần phạm vi tra cứu rộng hơn, xem tài liệu Dữ Liệu Tham Chiếu (Reference) của thư viện vnstock_data thuộc bản Mở rộng dành cho người tài trợ.
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.
Khuyên dùng: Nên ưu tiên sử dụng Agent Guide để nạp môi trường cho AI Agent trên máy tính cục bộ. Tránh viết code thủ công hoặc dùng AI phiên bản web như ChatGPT như ChatGPT/Google Colab vì AI không có thông tin mới nhất về thư viện nên dễ viết sai cú phá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: Kết nối tới nguồn VCI (
list_by_industry) có thể không khả dụng từ một số môi trường đám mây như Google Colab. Khi chạy trên Colab, thư viện 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ủ.
4. Tìm kiếm
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")Các phương thức trong nhóm Reference ở trên đều có trong Bản Cộng đồng. Nếu bạn cần phạm vi tra cứu rộng hơn hoặc các lớp dữ liệu đã chuẩn hoá cho quy trình 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 Mở rộng.