finlens 0.1.11

High-performance Python client for the FinLens financial data platform.

🐍 FinLens Python SDK

FinLens mang tới bộ client Python hiệu năng cao để truy cập hệ sinh thái dữ liệu tài chính Việt Nam.
Thư viện được thiết kế an toàn, linh hoạt và tối ưu cho ba nền tảng:
🪟 Windows | 🐧 Linux | 🍎 macOS

---

🚀 Cài đặt

Cài đặt trực tiếp từ PyPI:

pip install finlens

Yêu cầu:

• Python ≥ 3.10
• pandas ≥ 2.1.2
• requests

📘 Tài liệu hướng dẫn

---

⚙️ Khởi tạo nhanh

Ví dụ cơ bản để lấy dữ liệu giá đóng cửa của cổ phiếu HPG | chỉ số VNINDEX | ngành Ngân hàng trong năm 2023:

import finlens as fn

client = fn.client(apiKey="YOUR_API_KEY")
# Dữ liệu cổ phiếu
Stock = client.eod.stock
data = Stock.ohlcv(symbol="HPG", start="2023-01-01", end="2023-12-31")

# Dữ liệu chỉ số index
Market = client.eod.market
data = Market.ohlcv(symbol="VNINDEX", start="2023-01-01", end="2023-12-31")

# Dữ liệu ngành
Sector = client.eod.sector
data = Sector.ohlcv(symbol="Ngân hàng", start="2023-01-01", end="2023-12-31")
print(data)

📘 Kết quả trả về là pandas.DataFrame gồm các cột: Date, Open, High, Low, Close, Volume.

---

🧩 Cấu trúc thư viện

FinLens được chia thành nhiều client module riêng biệt, mỗi module phụ trách một mảng dữ liệu:

Module	Mô tả	Ví dụ truy cập
client.eod	Dữ liệu cuối ngày (EOD)	client.eod.stock.ohlcv(symbol="HPG") client.eod.stock.flow(symbol="HPG", group='local_individual') Các nhóm group phổ biến: - "foreign" — Nhà đầu tư nước ngoài (tổng hợp) - "proprietary" — Tự doanh công ty chứng khoán - "local_institutional" — Tổ chức trong nước - "local_individual" — Cá nhân trong nước - "foreign_institutional" — Tổ chức nước ngoài - "foreign_individual" — Cá nhân nước ngoài
client.info	Thông tin doanh nghiệp & cổ phiếu	client.info.overview("VNM") (đang phát triển)
client.financials	Báo cáo tài chính	client.financials.statement("HPG") (đang phát triển)

Tất cả đều trả về DataFrame hoặc dict để dễ dàng xử lý trong phân tích định lượng.

---

🔐 Bảo mật & hiệu năng

• Tự động xác thực bằng apiKey
• Kết nối HTTP được tối ưu hóa với requests.Session
• Tuân thủ chuẩn PEP 561 – hỗ trợ gợi ý kiểu (type hints)

---

📚 Bắt đầu khám phá

👉 Tiếp tục đọc tại:

• Tổng quan API
• Clients: EOD, Info, Financials, Index

Hoặc tra cứu chi tiết từng hàm trong sidebar bên trái.

---

🧠 Giấy phép & Liên hệ

• License: MIT
• Tác giả: FinLens Development Team
• Website: https://finlens.vn
• Liên hệ hỗ trợ: [e-mail]
• SĐT: Zalo - 035.905.2501

---

💡 FinLens – Nền tảng dữ liệu mở, giúp nhà đầu tư, doanh nghiệp và lập trình viên tiếp cận dữ liệu tài chính Việt Nam một cách nhanh chóng và hiệu quả.