Skip to main content

Intelligent caching wrapper for AKShare with 90%+ performance boost - 100% English codebase (import as 'qdb')

Project description

QuantDB - Intelligent Stock Data Caching

PyPI version PyPI - Downloads PyPI - Python Version License: MIT Performance

Intelligent caching wrapper for AKShare with 90%+ performance boost - Complete stock data ecosystem with smart SQLite caching for Chinese financial markets.

๐Ÿ“Š Note: Download statistics may take 24-48 hours to appear on PyPI and third-party services after a new release.

๐Ÿš€ Quick Start

pip install quantdb  # One command, instant 90%+ speed boost!
import qdb  # Note: import name is 'qdb' for simplicity

# Multiple ways to get stock data - all 90%+ faster than AKShare!
df = qdb.get_stock_data("000001", days=30)  # Simple: last 30 days
df = qdb.get_stock_data("000001", "20240101", "20240131")  # Date range
df = qdb.get_stock_data("000001", start_date="20240101", end_date="20240131")  # Keywords

โœจ Key Features

  • ๐Ÿš€ 90%+ Performance Boost: Local SQLite cache avoids repeated network requests
  • ๐Ÿง  Smart Incremental Updates: Only fetch missing data, maximize cache efficiency
  • โšก Millisecond Response: Cache hit response time < 10ms
  • ๐Ÿ“… Multi-Market Trading Calendar: Professional-grade calendars for China A-shares + Hong Kong stocks
  • ๐Ÿ‡ญ๐Ÿ‡ฐ Hong Kong Stock Support: Native HKEX support with intelligent market detection
  • ๐Ÿ”ง Zero Configuration: Automatically initialize local cache database
  • ๐Ÿ”„ Full AKShare Compatibility: Drop-in replacement with same API interface
  • ๐ŸŒ 100% English Codebase: International developer friendly
  • ๐ŸŽฏ Multi-Market Support: A-shares + Hong Kong stocks unified API
  • ๐Ÿ“ˆ Real-time Data: Live stock prices with intelligent caching
  • ๐Ÿ“Š Financial Indicators: Comprehensive financial metrics and ratios
  • ๐Ÿ” Stock Discovery: Complete stock list with market filtering

๐Ÿ“Š Performance Comparison

Operation AKShare QuantDB Improvement
First Request ~1000ms ~1000ms Same
Cache Hit ~1000ms ~18ms 98.1% faster
Bulk Operations Very Slow Lightning Fast 90%+ faster

๐Ÿ”ง Core API

Basic Usage

import qdb

# Historical stock data (multiple call patterns supported)
df = qdb.get_stock_data("000001", days=30)  # Last 30 days
df = qdb.get_stock_data("000001", "20240101", "20240131")  # Date range
df = qdb.get_stock_data("000001", start_date="20240101", end_date="20240131")  # Keywords
df = qdb.get_stock_data("600000", start_date="20240101", end_date="20240201")

# Multiple stocks
stocks_data = qdb.get_multiple_stocks(["000001", "000002"], days=30)

# Asset information
asset_info = qdb.get_asset_info("000001")

# Cache management
stats = qdb.cache_stats()  # View cache statistics
qdb.clear_cache()         # Clear cache if needed

Advanced Features (v2.2.9)

import qdb

# Multi-market support with intelligent detection
df_china = qdb.get_stock_data("000001", days=30)  # China A-shares (auto-detected)
df_hk = qdb.get_stock_data("00700", days=30)      # Hong Kong stocks (auto-detected)

# Real-time stock quotes with intelligent caching
realtime = qdb.get_realtime_data("000001")
batch_realtime = qdb.get_realtime_data_batch(["000001", "000002"])

# Complete stock list with market filtering
all_stocks = qdb.get_stock_list()  # All markets
shse_stocks = qdb.get_stock_list(market="SHSE")  # Shanghai Stock Exchange
szse_stocks = qdb.get_stock_list(market="SZSE")  # Shenzhen Stock Exchange
hkex_stocks = qdb.get_stock_list(market="HKEX")  # Hong Kong Exchange

# Index data (now available via top-level qdb)
index_hist = qdb.get_index_data("000001", start_date="20240101", end_date="20240201")
index_rt = qdb.get_index_realtime("000001")
index_list = qdb.get_index_list()  # Or filter by category

# Financial data and indicators
financial_summary = qdb.get_financial_summary("000001")  # Key metrics
financial_indicators = qdb.get_financial_indicators("000001")  # Detailed ratios

AKShare Compatibility

import qdb

# 100% compatible with AKShare API
df = qdb.stock_zh_a_hist("000001", start_date="20240101", end_date="20240201")

Configuration

import qdb

# Custom cache directory
qdb.set_cache_dir("./my_custom_cache")

# Logging level
qdb.set_log_level("INFO")  # DEBUG, INFO, WARNING, ERROR

๐Ÿ” Feature details

  • Real-time data: Trading-hours TTL vs. off-hours TTL to minimize latency and API calls; automatic cache hit detection and graceful fallback
  • Stock list: Market filter via market="SHSE"/"SZSE"/"HKEX"; daily caching with force_refresh toggle
  • Financial metrics: Summary and indicators endpoints designed for quick lookups and lightweight analysis

๐ŸŽฏ Use Cases

  • Quantitative Research: Frequent backtesting with cached historical data
  • Algorithm Trading: Real-time data access with minimal latency
  • Financial Analysis: Large-scale data processing with performance optimization
  • Portfolio Management: Multi-asset data retrieval and analysis
  • Academic Research: Reliable data source for financial studies

๐ŸŽ‰ What's new in v2.2.9

  • โœ… Multi-Market Trading Calendar: Upgraded from AKShare to pandas_market_calendars with Hong Kong support
  • โœ… Hong Kong Stock Exchange: Native HKEX support with intelligent symbol detection (00700 โ†’ HK, 000001 โ†’ China)
  • โœ… 197+ Global Exchanges: Professional-grade calendar support for future expansion
  • โœ… Enhanced Performance: Improved test coverage (77%+) and error handling
  • โœ… AI Agent Ready: Enhanced documentation for better AI tool integration
  • โœ… 100% Backward Compatible: All existing code continues to work unchanged

๐Ÿ“š Documentation & Support

๐Ÿ—๏ธ Architecture

QuantDB provides multiple deployment options:

  1. ๐Ÿ“ฆ Python Package (This Package): Local caching for individual developers
  2. ๐Ÿš€ API Service: Enterprise-grade REST API with advanced features
  3. โ˜๏ธ Cloud Platform: Web interface with visualization and monitoring

๐Ÿค Contributing

We welcome contributions! Please see our Contributing Guide for details.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgments

  • Built on top of the excellent AKShare library
  • Inspired by the need for high-performance financial data access in Python

Note: Package name is quantdb, import name is qdb (similar to scikit-learn โ†’ sklearn)

Made with โค๏ธ for the Python quantitative finance community

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quantdb-2.2.12.tar.gz (182.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quantdb-2.2.12-py3-none-any.whl (95.2 kB view details)

Uploaded Python 3

File details

Details for the file quantdb-2.2.12.tar.gz.

File metadata

  • Download URL: quantdb-2.2.12.tar.gz
  • Upload date:
  • Size: 182.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for quantdb-2.2.12.tar.gz
Algorithm Hash digest
SHA256 93a87fce00ad8d2ebcee09a6feaa7d0e5bec659ae58256e0f236adddce753137
MD5 15537c0816dc55bb97b77b92b4f5b92c
BLAKE2b-256 3c6f8b5a60adcd4a441a61f0d3ef4015186d1a070a976e8f235d8d09742a9ad9

See more details on using hashes here.

File details

Details for the file quantdb-2.2.12-py3-none-any.whl.

File metadata

  • Download URL: quantdb-2.2.12-py3-none-any.whl
  • Upload date:
  • Size: 95.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for quantdb-2.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 972bec728a2cb50d2c890d987c6bf60c01c69f0ccecc19b8ea6fe413ef686e96
MD5 60ece7a861b0249df319f5e2f44e5d00
BLAKE2b-256 bf8905ff00f7360d0b4cecf1f6d45436644ae268d9b01a604d7a5b3ab747269d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page