Giới thiệu vnstock-oapi
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.
vnstock-oapi là thư viện Python và công cụ dòng lệnh chạy trên máy bạn. Bạn dùng khoá của chính mình để đăng nhập và
gọi Open API của nguồn bạn chọn. Thư viện lo phần kết nối: cất khoá, mở và giữ phiên, lấy lại token khi hết hạn, lật
hết các trang, chờ khi nguồn giới hạn tần suất, đọc thông báo lỗi.
Mã nguồn của vnstock-oapi được phát hành công khai trên GitHub tại github.com/vnstock-hq/vnstock-open-api
để cộng đồng tự kiểm tra cách thư viện xử lý khoá, phiên và kết nối ngay trên máy mình.
Với người đang dùng bản Cộng đồng của vnstock 4.x hay 5.x: ở thế hệ 6, phần kết nối nguồn được tách độc lập vào vnstock-oapi.
Thư viện được cung cấp cho mục đích cá nhân, học tập và nghiên cứu phi thương mại.
Làm được gì
- Thử nhanh một Open API. Có khoá là kiểm được ngay: khoá dùng được không, request gửi đi trông thế nào, nguồn trả về những trường gì. Không phải dựng dự án riêng chỉ để gọi thử.
- Không phải tự viết phần kết nối cho từng nguồn. Mỗi nguồn một kiểu xác thực: một API key, cặp key và secret để lấy token, ký từng request, hay OTP mỗi lần mở phiên. Thư viện gom chúng về cùng một cách gọi.
- Có dữ liệu gốc sạch cho bước sau. Mỗi lần gọi cho ra một bản ghi cùng cấu trúc: dữ liệu nguồn trả về giữ nguyên,
kèm nguồn, thao tác đã gọi và thời điểm lấy.
vnstock6 đọc thẳng các bản ghi này để chuẩn hoá thành bảng.
Là gì, không là gì
| Là | Không là |
|---|---|
| Thư viện Python và công cụ dòng lệnh chạy trên máy bạn | Không phải bên cung cấp dữ liệu. Dữ liệu thuộc về nguồn |
| Công cụ giúp bạn tự lấy dữ liệu qua Open API, bằng tài khoản và khoá của bạn | Không phải máy chủ trung gian. Request đi từ máy bạn tới nguồn bạn chọn |
| Chỉ đọc: dữ liệu thị trường, danh sách mã, sự kiện doanh nghiệp | Không đặt lệnh, không đọc thông tin tài khoản. Không có hàm nào làm việc đó |
| Trả về dữ liệu gốc của nguồn, kèm thông tin nguồn gốc | Không phải bộ chuẩn hoá. Việc đó thuộc thư viện vnstock 6 |
| Phần mềm nghiên cứu, cung cấp theo hiện trạng | Không phải khuyến nghị đầu tư |
vnstock-oapi không gọi tới vnstocks.com và không gửi số liệu đo lượt dùng. Trên máy bạn, nó lưu khoá và phiên trong
keyring của hệ điều hành, hoặc trong tệp chỉ tài khoản của bạn đọc được, và ghi tệp dữ liệu khi bạn yêu cầu.
Nguồn có trong bản này
| Nguồn | source= | Cách xác thực | Biến môi trường |
|---|---|---|---|
| SSI FastConnect API | ssi | Key và secret để lấy token, tự lấy lại khi hết hạn | SSI_API_KEY, SSI_API_SECRET |
| DNSE Lightspeed API | dnse | Key và secret, ký từng request, không cần phiên | DNSE_API_KEY, DNSE_API_SECRET |
| TCBS iFlash Open API | tcbs | API key cùng Smart OTP gõ tay khi mở phiên; phiên dùng tối đa 24 giờ | TCBS_API_KEY |
| FHSC Open API | fhsc | Một API key gửi kèm mỗi request | FHSC_API_KEY |
| Financial Modeling Prep | fmp | Một API key gửi kèm mỗi request; dữ liệu thị trường quốc tế | FMP_API_KEY |
| Binance (dữ liệu thị trường công khai) | binance | Không cần khoá | Không có |
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 đó. Bạn chỉ cần khoá ở nguồn bạn định dùng.
Xem nguồn hỗ trợ những gì: vnstock-oapi ops <nguồn>. Đọc tóm tắt điều khoản: vnstock-oapi terms <nguồn>.
Đứng ở đâu trong thế hệ 6
khoá của bạn ─▶ vnstock-oapi ─▶ bản ghi dữ liệu gốc ─┬─▶ mã phân tích của bạn
(kết nối) ├─▶ vnstock 6: chuẩn hoá thành bảng
└─▶ vnstock-pipeline 6: nạp theo lịch, lưu trên máyDùng riêng vnstock-oapi khi bạn cần dữ liệu gốc của nguồn hoặc muốn tự viết bước xử lý. Cần bảng chuẩn hoá, cột
thống nhất giữa các nguồn, thì cài thêm vnstock thế hệ 6.
Giấy phép
Mã nguồn vnstock-oapi được công khai trên GitHub tại github.com/vnstock-hq/vnstock-open-api
theo giấy phép sử dụng riêng của Vnstock:
- Được dùng cho mục đích cá nhân, học tập và nghiên cứu phi thương mại.
- Được chia sẻ gói mở rộng của bạn dùng
vnstock-oapilàm phụ thuộc, theo điều kiện trong giấy phép: không đóng gói kèm mãvnstock-oapi, không thu phí, mỗi người dùng tự kết nối bằng khoá của mình, không đặt lệnh hay lấy thông tin tài khoản, ghi rõ nguồn gốc. - Phân phối lại phần mềm, dùng cho hoạt động thương mại, hoặc làm sản phẩm mà giá trị chính là giúp người khác lấy dữ liệu: cần văn bản đồng ý riêng của Vnstock.
- Quyền dùng phần mềm không gồm quyền dùng dữ liệu của nguồn. Dữ liệu bạn lấy về tuân theo điều khoản bạn đã đồng ý với nguồn đó.