Dòng lệnh
Mục lục
Trang này viết cho vnstock_oapi v0.1.0rc1, 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.
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ị.
Hầu hết các lệnh thao tác dữ liệu có dạng vnstock-oapi <lệnh> <nguồn> ... (các lệnh kiểm tra chung như status hoặc
check có thể chạy độc lập cho mọi nguồn). Chọn nguồn bạn đã có khoá ở thanh đầu trang: lệnh bên dưới điền
tên nguồn và một mã hợp với nguồn đó. Xem đủ lệnh: vnstock-oapi --help; xem một lệnh: vnstock-oapi <lệnh> -h.
Thử nhanh một nguồn
Có khoá là thử được ngay, không cần viết dòng mã nào:
vnstock-oapi keys set <nguồn> # cất khoá, không hiện ký tự khi gõvnstock-oapi check <nguồn> # khoá dùng được không: gọi thử một thao tác nhẹ
vnstock-oapi ops <nguồn> # nguồn có những hàm và thao tác nào
vnstock-oapi ohlc <nguồn> <mã> --preview # xem request sẽ gửi, chưa gửi; khoá đã được che
vnstock-oapi ohlc <nguồn> <mã> --start 2026-10-01 -o nen.jsonl
vnstock-oapi dump <nguồn> --symbol <mã> # gọi một loạt thao tác mẫu, báo cái nào chạy đượcCác lệnh
| Lệnh | Việc |
|---|---|
status | Khoá lấy từ đâu, phiên còn hạn không. Không gọi mạng, không in giá trị khoá |
keys set <nguồn>, keys delete <nguồn> | Cất hoặc xoá khoá trong keyring |
check [<nguồn> ...] | Tìm khoá và gọi thử một thao tác nhẹ nhất; bỏ trống để kiểm mọi nguồn |
auth <nguồn> | Mở phiên với nguồn cần phiên, hỏi OTP nếu nguồn cần; --clear xoá phiên, --clear --all xoá mọi phiên |
ops <nguồn> | Hàm chung, hàm riêng và thao tác gốc nguồn hỗ trợ |
terms <nguồn> | Tóm tắt điều khoản của nguồn, ghi số điều và đường dẫn văn bản gốc |
ohlc, trades, quote, index, foreign, symbols, calendar, events | Hàm chung, cùng tên ở mọi nguồn có hỗ trợ |
call <nguồn> <hàm> [đối số ...] | Hàm riêng của nguồn; tên hàm xem ở ops <nguồn> |
raw <nguồn> <thao-tác> [khoá=giá_trị ...] | Gọi thao tác gốc theo đúng tên và tham số trong tài liệu của nguồn |
dump <nguồn> [...] | Gọi một bộ thao tác mẫu, ghi JSONL và báo cáo hình dạng phản hồi |
stream <nguồn> [<kênh> ...] | Nhận dữ liệu thị trường trong phiên qua cổng WebSocket của nguồn |
Tuỳ chọn chung: --profile <hồ_sơ> chọn bộ khoá khi bạn có nhiều tài khoản ở cùng một nguồn.
Hàm chung
| Hàm | Lấy gì |
|---|---|
ohlc | Dữ liệu nến: giá mở, cao, thấp, đóng, khối lượng |
trades | Khớp lệnh từng lệnh |
quote | Giá và sổ lệnh mới nhất |
index | Dữ liệu chỉ số |
foreign | Giao dịch của nhà đầu tư nước ngoài |
symbols | Danh sách mã |
calendar | Ngày giao dịch |
events | Sự kiện doanh nghiệp |
Tham số: --start, --end (giờ không ghi múi giờ thì hiểu là giờ Việt Nam), --interval
(1m 3m 5m 15m 30m 1H 4H 1D 1W 1M, mặc định 1D), --limit, --asset. Nguồn không có khung thời gian bạn chọn thì
báo InputError; thư viện không tự gộp nến. Nguồn không có hàm thì báo UnsupportedError, không trả kết quả rỗng.
Mọi lệnh gọi dữ liệu nhận --preview (xem request, không gửi) và -o <tệp>.jsonl (ghi đủ kết quả). Không có -o
thì lệnh in tóm tắt và phần đầu của bản ghi đầu tiên.
Thao tác gốc
vnstock-oapi ops <nguồn> # tên thao tác gốc và tài liệu của từng thao tác
vnstock-oapi raw <nguồn> <thao-tác> <khoá>=<giá_trị> --preview
vnstock-oapi raw <nguồn> <thao-tác> <khoá>=<giá_trị> --page 2 -o trang2.jsonlTham số truyền nguyên cho nguồn. Nguồn chia trang thì thư viện tự lấy hết, mỗi trang một bản ghi; --page lấy đúng
một trang.
Ghi mẫu và xem hình dạng
dump ghi vào samples/<thời điểm>/:
<nguồn>/<tên>.jsonl: kết quả của từng thao tác.shapes.md: các trường và kiểu dữ liệu của mọi phản hồi, không kèm giá trị. Đọc tệp này là biết nguồn trả về những gì để thiết kế bước xử lý tiếp theo.manifest.json: thao tác nào chạy được, mã HTTP, lỗi nếu có.
Tuỳ chọn: --symbol, --index, --global-symbol, --global-index (mã cho nguồn quốc tế), --out (thư mục ghi).
Các tệp .jsonl là dữ liệu thật lấy bằng tài khoản của bạn. Điều khoản của nguồn thường cấm đưa cho bên thứ ba, kể cả
dữ liệu đã xử lý: để trên máy, không commit, không chia sẻ, không dán vào trợ lý AI trên đám mây.
Dữ liệu trong phiên
Cần phần stream (Cài đặt). Lệnh chỉ mở kênh dữ liệu thị trường mà nguồn công bố;
kênh lệnh và tài khoản bị chặn ngay trong thư viện. Bản 0.1.0rc1 có cổng stream ở binance, dnse, ssi,
tcbs; xem lại bằng vnstock-oapi stream -h.
vnstock-oapi stream <nguồn> # xem các kênh được phép
vnstock-oapi stream <nguồn> <kênh> --symbols <mã1>,<mã2> --seconds 60 -o frames.jsonlĐường dòng lệnh và Python của vnstock-oapi dễ đọc nhưng chậm. Theo dõi nhiều mã, chạy lâu, thì dùng
vnstock-pipeline thế hệ 6.