Vnstock thế hệ 6
Mục lục
Trang này viết cho vnstock v6.0.0rc2, bản thử nghiệm. Tên hàm, tham số và cột dữ liệu có thể còn đổi trước ngày phát hành; khi cài, ghi rõ số phiên bản như ở trang Cài đặt. Bản đang phát hành chính thức là v5.0.1, xem tài liệu bản đó.
Chọn nguồn bạn có khoá, mã trên trang sẽ điền theo. Chưa chọn thì mã giữ chỗ trống <nguồn>. Nguồn xếp theo bảng chữ cái, không phải khuyến nghị.
Với vnstock thế hệ 6, bạn dùng khoá do mình đăng ký để kết nối tới Open API của nguồn. Dữ liệu được
chuẩn hoá trên máy thành pandas.DataFrame với tên cột, kiểu dữ liệu và đơn vị thống nhất giữa các nguồn.
Cổng kết nối thuộc bản Cộng đồng, miễn phí cho cá nhân, học tập và nghiên cứu. Mã của cổng được công bố để bạn tự kiểm tra cách thư viện xử lý khoá và request. Các bước chuẩn hoá, tổ chức và tính toán nằm ở những lớp tiếp theo của bộ công cụ Vnstock.
Bản này có gì
- Dữ liệu giao dịch và tham chiếu: nến, khớp lệnh, bảng giá, sổ lệnh, khối ngoại, tự doanh; danh sách mã, rổ chỉ số, ngành, lịch sự kiện, thông tin doanh nghiệp, quỹ mở; tiền mã hoá, ngoại hối, hàng hoá. Mỗi hàm ghi rõ nguồn nào đọc được.
- Báo cáo tài chính (
Fundamental): bảng cân đối kế toán, kết quả kinh doanh, lưu chuyển tiền tệ, chuẩn hoá về bộ chỉ tiêu VAS với mã chỉ tiêu giữ như thế hệ 5, cho cả bốn mẫu biểu: doanh nghiệp, ngân hàng, công ty chứng khoán, bảo hiểm. Mỗi lời gọi tự kiểm các đẳng thức của mẫu biểu (Báo cáo tài chính). - Chưa có: chỉ số tài chính, thuyết minh, tài liệu công bố (
ratio,note,filing), xếp hạng và dòng tiền toàn thị trường (Insights), định giá (Analytics), vĩ mô (Macro). Open API mà bản này kết nối chưa có các dữ liệu đó. Gọi các hàm này sẽ nhận lỗi có mãVNSTOCK_ROUTE_UNSUPPORTED, không nhận bảng rỗng. - Lệnh
vnstocktrong terminal: kiểm máy, xem hàm, xem cách gọi, đổi ngôn ngữ. Gõvnstockkhông kèm lệnh để mở giao diện tương tác (Dòng lệnh và tra cứu hàm).
| Thế hệ 5 | Thế hệ 6 |
|---|---|
| Thư viện tự chọn nguồn mặc định | Bạn chọn nguồn: theo từng lời gọi, hoặc đặt sẵn cho từng nhóm hàm |
| Thư viện quản lý sẵn phần kết nối | Bạn dùng khoá của mình để kết nối Open API của nguồn |
| Mỗi nguồn có một bộ cột riêng | Mặc định dùng bộ cột thống nhất; bật columns="all" để lấy thêm trường riêng của nguồn |
Tên lớp Market, Reference | Giữ tên lớp và tên hàm; mã thế hệ 5 tiếp tục chạy ở những chức năng đã có dữ liệu |
Bắt đầu trong ba bước
pip install -U --extra-index-url https://vnstocks.com/api/packages "vnstock==6.0.0rc2" "vnstock-oapi==0.1.0rc1"
vnstock-oapi keys set <nguồn> # nhập khoá API bạn đăng ký ở nguồn, không hiện ký tự khi gõ
vnstock doctor # kiểm máy đã sẵn sàng chưa, kèm cách sửafrom vnstock import Market
df = Market("<nguồn>").equity("FPT").ohlcv(start="2026-10-01", end="2026-10-30")Chưa có khoá ở nguồn nào thì đọc Cài đặt và khoá nguồn trước.
Đọc theo thứ tự này
| Trang | Bạn làm được gì sau khi đọc |
|---|---|
| Cài đặt và khoá nguồn | Cài thư viện, đăng ký và lưu khoá của từng nguồn, rồi kiểm tra kết nối |
| Chọn nguồn | Chọn nguồn cho một lời gọi, hoặc đặt sẵn nguồn cho từng nhóm hàm, kèm nguồn dự phòng |
| Tham chiếu | Danh sách mã, rổ chỉ số, ngành, lịch sự kiện, thông tin doanh nghiệp, quỹ |
| Thị trường | Nến, khớp lệnh, bảng giá, sổ lệnh, khối ngoại, tự doanh, tiền mã hoá, ngoại hối, hàng hoá |
| Báo cáo tài chính | Bảng cân đối, kết quả kinh doanh, lưu chuyển tiền tệ theo chuẩn VAS; bộ chỉ tiêu đầy đủ và rút gọn; kiểm đẳng thức |
| Bộ cột và chuẩn hoá | Chọn bộ cột chuẩn, chung hay đầy đủ; hiểu đơn vị, giờ và thông tin kèm kết quả |
| Xử lý lỗi | Đọc mã lỗi và biết cách sửa |
| Dòng lệnh và tra cứu hàm | Dùng lệnh vnstock, giao diện tương tác, show_api(), show_doc() |
Khi cần thêm
- Tham khảo: kiến trúc, các nguồn và điều khoản, tự mang phong bì dữ liệu.
- Chuyển từ thế hệ 5: dành cho mã viết cho thế hệ 5.
Đang có mã viết cho thế hệ 5
Bốn điểm hay vấp:
- Không có nguồn mặc định.
Market().equity("FPT").ohlcv()báoVNSTOCK_INPUT_SOURCEnếu bạn chưa truyềnsource=hoặc đặt nguồn bằngvnstock.sources.use(...). - Tên cột, đơn vị, mốc giờ giữ như thế hệ 5 (hồ sơ
v5mặc định). Bảng nào khác thế hệ 5 thì có cảnh báoSchemaChangeWarningvàdf.attrs["schema_changes"]. - Tham số hàm không nhận được báo
VNSTOCK_INPUT_PARAM, không bị bỏ qua lặng lẽ. - Tham số của thế hệ 5 không có tương đương ở thế hệ 6 (
lang="en",last_id…) chỉ nhận giá trị mặc định; giá trị khác báoVNSTOCK_INPUT_PARAM. Trang chuyển đổi có danh sách.
Chi tiết ở Chuyển từ thế hệ 5.
Thư viện không làm gì
- Không tự chọn nguồn thay bạn, không tự đăng ký tài khoản ở nguồn.
- Không gửi khoá nguồn tới Vnstock hay nguồn khác; khoá chỉ được dùng trong request gửi tới nguồn bạn chọn.
- Không vượt giới hạn tần suất hay số bản ghi mỗi lần gọi mà nguồn đặt ra.
- Không đặt lệnh, không đọc tài khoản giao dịch: chỉ đọc dữ liệu thị trường và dữ liệu tham chiếu.
- Không cam kết độ đầy đủ hay thời gian phản hồi của nguồn; mỗi nguồn có giờ phục vụ và hạn mức riêng.
