Vnstock Logo

Công cụ dòng lệnh và tra cứu nhanh

Cộng đồng

Mục lục

Cài vnstock_quant xong là có lệnh vnstock-quant trong terminal: xem cấp quyền và lượt dùng thử còn lại, kiểm tra máy, tra danh mục hàm, chạy ví dụ mẫu và gọi thử công cụ JSON mà chưa cần viết mã Python. Mọi phép tính vẫn chạy trên máy bạn với cùng quy tắc quyền và cùng bộ đếm lượt như khi gọi từ Python.


Giao diện tương tác

Gõ vnstock-quant (không kèm tham số) hoặc python -m vnstock_quant:

Text
╭─ vnstock-quant 1.0.0 ───────────────────────────────╮
│ vnstock 6.0.0 · cấp quyền guest                     │
│ Hạn dùng của bản cài: còn 364 ngày (đến 2027-11-12) │
│ Nguồn có khoá: chưa có                              │
│                                                     │
│ Tiếp theo: onboard  làm quen từng bước              │
│                                                     │
│ help  xem lệnh     exit  thoát                      │
╰─────────────────────────────────────────────────────╯
vnstock-quant ❯

Gõ tên lệnh trực tiếp (có hoặc không có dấu / ở đầu). Trên macOS và Linux, phím Tab gợi ý tên lệnh; gõ sai chính tả thì giao diện gợi ý lệnh gần nhất. Gõ exit để thoát.

Làm quen từng bước với onboard

Gõ onboard để đi qua 5 bước:

  1. Kiểm tra máy: phiên bản thư viện, cấp quyền, các nhóm hàm được mở và thời hạn bản cài.
  2. Khoá nguồn dữ liệu (tuỳ chọn): nếu bạn muốn tải dữ liệu bằng vnstock 6, trình hướng dẫn gọi vnstock keys set <nguồn>. Bỏ qua bước này thì bạn vẫn tính bình thường trên bảng pandas có sẵn.
  3. Nguồn mặc định (tuỳ chọn): nhấn Enter để bỏ qua, hoặc chọn nguồn theo thứ tự ưu tiên.
  4. Chạy thử một phép tính: tính một chỉ báo trên dữ liệu tự sinh ngay trên máy, không cần mạng.
  5. Gợi ý đọc tiếp: đường dẫn tới các trang hướng dẫn.

Các lệnh hỗ trợ

Mọi lệnh gõ được trong giao diện tương tác hoặc gọi thẳng từ shell theo dạng vnstock-quant <lệnh>. Thêm --json để nhận đầu ra JSON cho script hoặc trợ lý AI.

NhómLệnhCông dụng
Khởi tạo và kiểm traonboardHướng dẫn 5 bước; chạy từ shell hoặc kèm --json thì xuất trạng thái máy, quy tắc sử dụng và bước tiếp theo
statusPhiên bản, cấp quyền, hạn dùng bản cài, nguồn đã có khoá
doctor [--live]Chẩn đoán môi trường kèm hướng dẫn khắc phục
Nguồn dữ liệusources [use <nguồn>… | clear]Xem, đặt hoặc xoá quy tắc nguồn mặc định khi tải bằng vnstock 6
Tra cứu và ví dụcatalog [nhóm] [tên]Danh mục hàm theo mô-đun; thêm tên chỉ báo hay mã chỉ số để xem chi tiết và nhóm quyền
example [chủ đề] [--run]In mã Python mẫu; thêm --run để chạy ngay
Giao diện JSONtools [tên]Liệt kê công cụ JSON; thêm tên để xem tham số
call <tên> [tham_số=giá_trị …]Gọi thử một công cụ JSON từ dòng lệnh
Cấu hìnhtelemetry [on | off]Xem, bật hoặc tắt thống kê lượt dùng ẩn danh trên máy
docs [chủ đề]Đường dẫn tới trang tài liệu tương ứng

Lệnh quản lý tài khoản và khoá nguồn thuộc công cụ vnstock (vnstock login, vnstock keys set <nguồn>, vnstock update); gõ trong giao diện của vnstock-quant thì chương trình tự chuyển sang lệnh vnstock tương ứng.


Chẩn đoán môi trường với doctor

Shell
vnstock-quant doctor
Text
[OK  ] Python 3.11.14 (cần >= 3.10)
[OK  ] Lõi tính toán vnstock_quant 1.0.0 nạp được
[OK  ] Hạn dùng của bản cài: còn 364 ngày (đến 2027-11-12)
[OK  ] Cấp quyền guest: mở ta_basic, fa_basic, bt_basic
[OK  ] vnstock 6.0.0, vnstock-oapi 0.1.1
[WARN] Nguồn có khoá: chưa có
...
[OK  ] Phép tính thử SMA trên dữ liệu tự sinh chạy được (tính một lượt ở bản Cộng đồng)

Môi trường sẵn sàng.

Dòng Nguồn có khoá: chưa có chỉ là nhắc nhở: không ảnh hưởng gì nếu bạn tính trên dữ liệu của mình. Nếu một hạng mục báo FAIL, lệnh trả mã thoát 1 để bạn dùng trong script kiểm tra tự động. status --json cho toàn bộ trường của vq.entitlement(), kể cả lượt dùng thử còn lại.


Tra danh mục hàm và chạy ví dụ

Shell
vnstock-quant catalog ta               # danh mục chỉ báo; cột access = ta_basic là 10 chỉ báo của bản Cộng đồng
vnstock-quant catalog fa RT_PRT_ROE    # công thức, đơn vị, mẫu ngành và nhóm quyền của ROE
vnstock-quant example ta --run         # mã mẫu tính chỉ báo, chạy ngay trên dữ liệu tự sinh
vnstock-quant example backtest --run   # mã mẫu chạy thử chiến lược một mã

Các chủ đề ví dụ dùng được ở bản Cộng đồng:

Chủ đềNội dungCần mạng
taTính chỉ báo kỹ thuật trên bảng giá có sẵnKhông
backtestChạy thử chiến lược theo quy định thị trường Việt NamKhông
dataTải nến qua vnstock 6 rồi tính chỉ báoCó (cần khoá nguồn)
faTải báo cáo tài chính qua vnstock 6 rồi tính chỉ sốCó (cần khoá nguồn)

Ví dụ không cần mạng dùng dữ liệu tự sinh trên máy; bạn có thể chép mã in ra vào notebook rồi thay bằng DataFrame của mình. Chạy ví dụ bằng --run vẫn trừ lượt như khi gọi hàm Python.


Gọi thử công cụ JSON

Shell
vnstock-quant tools run_backtest          # tham số của công cụ chạy thử chiến lược (dấu * là bắt buộc)
vnstock-quant call list_profiles          # các hồ sơ thị trường; công cụ list_* không trừ lượt
vnstock-quant call deflated_sharpe_ratio 'returns=[0.01,-0.005,0.008,0.002,-0.003,0.006]'

Bọc tham số dạng mảng trong dấu nháy đơn để zsh hoặc bash không hiểu nhầm dấu ngoặc vuông. call gọi thẳng backtest.call của thư viện, nên kết quả và mã lỗi giống hệt khi gọi từ Python hay qua Vnstock MCP. Xem Gọi hàm bằng JSON và tích hợp MCP.


Ngữ cảnh cho trợ lý AI

Nếu bạn dùng trợ lý lập trình AI (Claude Code, Cursor, Antigravity...), hãy bảo trợ lý chạy lệnh này ở đầu phiên:

Shell
vnstock-quant onboard --json

Đầu ra cho trợ lý biết thư viện làm gì, máy đang ở cấp nào và mở nhóm hàm nào, kèm quy tắc an toàn: lấy số bằng hàm của thư viện chứ không nhẩm từ trí nhớ; không hỏi, không đọc và không ghi khoá Open API; không tự chọn nguồn thay bạn; không diễn giải kết quả mô phỏng thành khuyến nghị đầu tư. Lệnh chỉ kiểm tra nguồn nào đã có khoá, không đọc giá trị khoá.


Thống kê lượt dùng (telemetry)

Shell
vnstock-quant telemetry        # xem trạng thái
vnstock-quant telemetry off    # tắt cho mọi thư viện Vnstock trên máy này

Phần thống kê không gửi mã chứng khoán, dữ liệu đầu vào và đầu ra, đường dẫn tệp hay nội dung chi tiết của thông báo lỗi. Cách Vnstock xử lý dữ liệu được nêu ở Chính sách quyền riêng tư.


Tài liệu đọc tiếp