Dùng trong Python

import vnstock_oapi as oapi

src = oapi.source("<nguồn>")                 # hoặc gọi tắt: oapi.<nguồn> (như oapi.ssi, oapi.dnse,...)
bars = src.ohlc("<mã>", start="2026-10-01", end="2026-10-30", interval="1D")

bars[0].body              # dữ liệu nguồn trả về, giữ nguyên
bars[0].operation         # thao tác đã gọi
bars.summary()            # mỗi bản ghi một dòng: thao tác, mã HTTP, mã băm, dung lượng
bars.save("nen.jsonl")    # mỗi dòng một bản ghi

oapi.sources()                       # các nguồn có trong bản này
oapi.status()                        # khoá lấy từ đâu, phiên còn hạn không; không gọi mạng
print(oapi.terms("<nguồn>"))         # tóm tắt điều khoản, kèm đường dẫn văn bản gốc

src.ops                              # hàm và thao tác gốc nguồn hỗ trợ
src.preview("ohlc", "<mã>")          # request sẽ gửi, chưa gửi; khoá đã được che
src.raw("<thao-tác>", <khoá>="<giá_trị>")   # thao tác gốc, tham số đúng như tài liệu của nguồn

import getpass

src.authenticate(getpass.getpass("OTP: "))
src.clear_auth()                     # xoá phiên đang giữ

env = oapi.wrap("<nguồn>", "<thao-tác>", body=my_json, request={"symbol": "<mã>"})

from vnstock_oapi import errors

try:
    bars = oapi.source("<nguồn>").ohlc("<mã>", start="2026-10-01")
except errors.CredentialError as exc:
    print(exc)          # thiếu khoá: thông báo ghi đúng tên biến môi trường cần đặt
except errors.OapiError as exc:
    print(type(exc).__name__, exc)

import vnstock_oapi as oapi
from vnstock_oapi import ext

SPEC = ext.SourceSpec(
    name="demo",
    title="Demo API",
    base_url="https://api.example.com/v1",
    hosts=frozenset({"api.example.com"}),
    credentials=(ext.CredentialField("api_key", "API_KEY"),),
    auth=lambda source: ext.ApiKeyHeaderAuth(source, header="X-Api-Key"),
    ops={"bars": ext.Op("bars", "/bars/{symbol}", doc="https://example.com/docs/bars")},
    verbs={"ohlc": lambda symbol, **kw: ext.Plan("bars", {"symbol": ext.symbol("demo", symbol), **kw})},
)

TERMS = ext.Terms(
    source="demo",
    title="Demo API",
    terms_url="https://example.com/terms",
    docs_url="https://example.com/docs",
    checked_at="2026-11-01",
    summary=("Chỉ dùng cho cá nhân.", "Không phân phối lại dữ liệu."),
)

oapi.register(SPEC, terms=TERMS, producer=("my-package", "0.1.0"))