Dòng lệnh và tra cứu hàm

Cài vnstock xong, máy có lệnh vnstock trong terminal. Lệnh này giữ tên và cách dùng của thế hệ 5: tài khoản, kiểm máy, phiên bản, cập nhật, ngôn ngữ. Thế hệ 6 thêm hai lệnh để tra hàm: tools và doc.

Giao diện tương tác

Gõ vnstock không kèm lệnh để mở giao diện tương tác:

Text

╭─ vnstock 6.0.0rc2 ────────────────────────────────╮
│ Chưa đăng nhập tài khoản Vnstock (không bắt buộc) │
│ Bản này dùng được đến hết 05/12/2026              │
│                                                   │
│ help  xem lệnh     exit  thoát                    │
╰───────────────────────────────────────────────────╯

vnstock ❯

Khung đầu cho biết tài khoản, cấp quyền và ngày cuối bản đang cài còn dùng được (ngày trong ví dụ là minh hoạ). Gõ tên lệnh, có hoặc không có dấu / (doctor, /doctor). Phím Tab gợi ý tên lệnh. help liệt kê các lệnh theo nhóm, kèm vài ví dụ code. Trong giao diện này còn có data: xem nhanh 5 phiên gần nhất của một mã kèm đoạn code tạo ra bảng đó.

Text

vnstock ❯ data price FPT ssi

Giao diện tương tác chỉ mở khi bạn gõ trong terminal. Trong script hoặc khi chuyển hướng đầu ra, vnstock không kèm lệnh chỉ in danh sách lệnh.

Các lệnh

Nhóm	Lệnh	Việc
Tài khoản	`vnstock login`	Đăng nhập bằng khoá API lấy tại vnstocks.com
	`vnstock logout`	Đăng xuất trên máy này
	`vnstock status`	Tài khoản, cấp quyền, hạn dùng của bản đang cài
Dữ liệu	`vnstock tools [nhóm]`	Các hàm lấy dữ liệu, theo nhóm, kèm nguồn có dữ liệu
	`vnstock doc <hàm>`	Cách gọi một hàm: tham số, nguồn, cột trả về ở hai hồ sơ; `--full` in cả hai ngôn ngữ
Trợ lý AI	`vnstock onboard`	Hướng dẫn ngắn cho trợ lý AI trước khi dùng vnstock
	`vnstock skills [show <tên>]`	Skill cho trợ lý AI trên vnstocks.com, skill nào cấp của bạn đọc được
Kiểm tra và cập nhật	`vnstock doctor`	Máy đã sẵn sàng chưa, kèm cách sửa từng mục
	`vnstock keys`	Nguồn nào đã có khoá, khoá lấy từ đâu, nguồn nào cần mở phiên
	`vnstock version`	Phiên bản các thư viện Vnstock đang cài và bản mới nhất
	`vnstock report`	Khối thông tin để chép khi hỏi hỗ trợ, không chứa khoá
	`vnstock update`	Cập nhật mọi thư viện Vnstock đã cài; `--dry-run` để xem lệnh, `--tool pip \| uv`
	`vnstock install [tên…]`	Cài thư viện bổ sung mà gói quyền sử dụng của bạn có; `--list` để xem, `--dry-run` để in lệnh
	`vnstock policy`	Nguồn hoặc phiên bản đang tạm dừng theo thông báo của vnstocks.com
Cài đặt	`vnstock language vi \| en \| both`	Ngôn ngữ hiển thị
	`vnstock telemetry [on \| off]`	Xem, bật, tắt việc đếm lượt dùng
	`vnstock env`	Thư mục lưu trạng thái trên máy
	`vnstock completion [bash \| zsh \| fish \| powershell]`	Gợi ý lệnh bằng phím Tab cho shell

vnstock <lệnh> -h xem tuỳ chọn của một lệnh. vnstock --json <lệnh> in kết quả JSON cho script. Khoá của nguồn dữ liệu do lệnh vnstock-oapi quản lý (Cài đặt và khoá nguồn).

Tra hàm trong terminal

Shell

vnstock tools                      # mọi hàm dùng được, theo nhóm
vnstock tools Market.equity        # một nhóm
vnstock tools --source <nguồn>     # chỉ hàm đọc được từ nguồn đó
vnstock tools Market --all         # thêm hàm của thế hệ 5 chưa có nguồn và hàm đã ngừng
vnstock doc Market.equity.trades   # cách gọi, tham số, nguồn, cột trả về

vnstock doc in đoạn code gọi hàm, tham số, nguồn đọc được, tên khác giữ từ thế hệ 5, và cột trả về ở cả hai hồ sơ v5 và v6.

Tra hàm trong Python

Python

from vnstock import Market, show_api, show_doc

show_api()                          # mọi hàm dùng được
show_api("Market.equity")           # một nhóm
show_api(Market("<nguồn>").index)   # nhóm của một đối tượng, chỉ hàm nguồn đó đọc được
show_api(all=True)                  # thêm hàm chưa có nguồn và hàm đã ngừng
df = show_api(as_frame=True)        # danh sách dạng DataFrame để lọc
show_doc("Market.equity.ohlcv")     # cách gọi một hàm

show_api và show_doc dùng chung dữ liệu với vnstock tools và vnstock doc, nên hai nơi luôn khớp nhau.

Ngôn ngữ

Shell

vnstock language          # ngôn ngữ đang dùng
vnstock language en       # tiếng Anh
vnstock language both     # song ngữ: tiếng Việt, tiếng Anh ở dòng dưới
vnstock language default  # về mặc định (tiếng Việt)

Lựa chọn lưu ở ~/.vnstock/settings.json và dùng chung cho thế hệ 5 và thế hệ 6 trên cùng máy. Biến môi trường VNSTOCK_LANG đổi ngôn ngữ cho một lần chạy. Ngôn ngữ áp dụng cho lệnh vnstock, giao diện tương tác, show_api, show_doc; tên hàm và tên cột không đổi theo ngôn ngữ.

Màu

Lệnh vnstock chỉ in màu khi chạy trong terminal. Đặt biến môi trường NO_COLOR để tắt màu.

Mục lục