Vnstock Logo

Nguồn và dữ liệu

Thử nghiệm

Mục lục

Bản thử nghiệm, chưa phát hành chính thức

Trang này viết cho vnstock_mcp v1.0.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. Bản đang phát hành chính thức là v0.4.0, xem tài liệu bản đó.

Tool dữ liệu của vnstock-mcp gọi đúng hàm của vnstock 6, cùng tên. Market().equity("FPT").ohlcv() trong Python là market_equity(symbol="FPT", method="ohlcv") khi trợ lý gọi. Dữ liệu đến từ Open API của nguồn, bằng khoá của bạn.

Chọn nguồn

Thế hệ 6 không có nguồn mặc định: mỗi nguồn là một tài khoản riêng của bạn, theo điều khoản riêng của nguồn đó. Vì vậy mọi tool dữ liệu nhận thêm tham số source.

  • Trợ lý nêu source="ssi" trong lời gọi: dùng đúng nguồn đó.
  • Bỏ trống source: dùng quy tắc bạn đã lưu bằng vnstock.sources. Không có quy tắc thì lời gọi báo lỗi kèm danh sách nguồn đọc được, để trợ lý hỏi bạn hoặc chọn lại.
  • vnstock-mcp không tự chọn nguồn thay bạn.

Lưu quy tắc một lần cho mọi phiên, gõ trong terminal:

Shell
vnstock-mcp sources                          # nguồn dùng được trên máy, quy tắc đang áp
vnstock-mcp sources which market.equity.ohlcv  # nguồn nào đọc được loại dữ liệu này
vnstock-mcp sources use ssi dnse             # ssi là chính, dnse dự phòng, cho mọi loại dữ liệu
vnstock-mcp sources use fhsc --route "fundamental.equity.*"
vnstock-mcp sources clear

Trong cuộc trò chuyện, trợ lý tự hỏi research_sources: nguồn nào dùng được trên máy, nguồn nào đọc được một loại dữ liệu. Tool này không gọi mạng và không bao giờ trả khoá. Cách quy tắc nguồn hoạt động: Chọn nguồn trong vnstock 6.

Mã tương đương luôn ghi nguồn đã dùng, kể cả khi nguồn đến từ quy tắc đã lưu, để script chạy lại được ở máy khác.

Các tool dữ liệu

Danh sách dưới đây là toàn bộ tool có route đọc được trong bản 1.0.0rc1. Trên máy bạn chỉ hiện những tool và giá trị method mà nguồn bạn có khoá đọc được (Tool nào hiện ra).

ToolDùng khimethod
reference_companyHồ sơ doanh nghiệpinfo, shareholders, ownership, insider_trading, events
reference_equityDanh sách mã theo sàn, ngành, rổ chỉ số; giá trần sàn; trạng thái giao dịchlist, list_by_group, list_by_exchange, list_by_industry, price_limits, status
reference_indexDanh mục chỉ số và mã thành phầnlist, groups, members, info
reference_industryPhân ngành ICBlist, sectors
reference_instrumentETF, hợp đồng tương lai, chứng quyền, trái phiếu (kind)list, info
reference_fundQuỹ mởlist, profile
reference_eventsLịch sự kiện: cổ tức, đại hội cổ đông, niêm yết, ngày nghỉcalendar, market
reference_marketTrạng thái phiên, mốc phiên, ngày giao dịchstatus, sessions, trading_days
reference_searchTìm mã ngoại tệ, hàng hoá, chỉ số quốc tế
market_equityGiá cổ phiếuohlcv, trades, order_book, quote, session_stats, foreign_flow, proprietary_flow, block_trades, volume_profile, trade_history, active_flow, expected_price, summary
market_indexChỉ số VN-Index, VN30, HNXohlcv, quote, trade_history, foreign_flow, proprietary_flow
market_etfChứng chỉ quỹ ETFohlcv, trades, order_book, quote, session_stats, foreign_flow, summary
market_futuresHợp đồng tương laiohlcv, trades, order_book, quote
market_warrantChứng quyền có bảo đảmohlcv, trades, order_book, quote
market_cryptoTiền mã hoáohlcv, trades, order_book, quote, vwap, daily_stats, last_price, rolling_stats, reference_price
market_forexTỷ giá quốc tế theo thời gian
market_commodityGiá hàng hoá thế giới
market_global_indexChỉ số chứng khoán quốc tế
market_fundLịch sử NAV, hiệu suất quỹ mởhistory, performance
market_boardBảng giá nhiều mã cùng lúcquote, put_through, foreign_room
fundamental_equityBáo cáo tài chínhincome_statement, balance_sheet, cash_flow

Tham số chung của nhóm market_*: symbol, start/end (YYYY-MM-DD), length (khoảng nhìn lại: '3M', '1Y', '100b' = 100 nến), interval, limit, params (tham số riêng của hàm), source.

Các tầng macro, insights, analytics, retail của vnstock chưa có nguồn Open API nào đọc được trong bản này, nên không có tool nào hiện ra. Khi thư viện có kết nối mới, bản sau sẽ tự mở.

Đơn vị

BảngĐơn vị giá
market_equity ohlcvnghìn VND
market_boardVND
quant_prices (giá điều chỉnh)VND

Công cụ chạy thử chiến lược tự nhận ra đơn vị của bảng giá (price_unit="auto").

Trợ lý nhận được gì

Mỗi kết quả là JSON gọn:

TrườngNghĩa
call_idMã tham chiếu kết quả trong phiên: c1, c2… Bước sau dùng nó thay cho số liệu
codeMã Python tương đương của bước này, rút gọn khi dài; mã đủ nằm trong nhật ký phiên
provenanceNguồn đã dùng, tuyến dữ liệu, thời điểm lấy, phiên bản thư viện
columns, dataCác dòng gần nhất (mặc định 60 dòng), số làm tròn. Bảng đủ nằm trong call_id
rows, returned, truncated, noteBảng có bao nhiêu dòng, hiện bao nhiêu, có bị cắt không, và cách dùng đủ bảng
warningsCảnh báo của thư viện, giữ nguyên văn: thay đổi so với thế hệ 5, dữ liệu ở mức thử nghiệm, sự kiện lệch giá tham chiếu…

Lỗi trả về {error, message, hint}. Trợ lý làm theo hint: đổi source, sửa tham số, hoặc gọi lại sau.