Skip to main content

Mostly day quotes of cn/hk/us/fund/future markets, side with quote list fetch

Project description

rquote

rquote 是一个提供 A股/港股/美股/ETF基金/期货 历史数据获取的Python库

版本信息

当前版本:0.5.6

主要特性

  • ✅ 支持多市场数据获取(A股、港股、美股、期货、基金)
  • ✅ 统一的API接口,使用简单
  • ✅ 内置缓存机制,提升性能
  • ✅ 完善的错误处理和异常体系
  • ✅ 可配置的HTTP客户端(超时、重试等)
  • ✅ 模块化设计,易于扩展

安装

pip install rquote

或使用 uv:

uv pip install rquote

快速开始

基本使用

from rquote import get_price

# 获取上证指数数据
sid, name, df = get_price('sh000001')
print(df.head())  # 数据为pandas DataFrame

获取指定日期范围的数据

# 获取指定日期范围的数据
sid, name, df = get_price('sz000001', sdate='2024-01-01', edate='2024-02-01')

使用缓存

内存缓存(MemoryCache)

from rquote import get_price, MemoryCache

# 创建缓存实例(ttl 单位:秒)
cache = MemoryCache(ttl=3600)  # 缓存 1 小时

# 使用缓存(通过dd参数传递MemoryCache实例)
sid, name, df = get_price('sh000001', dd=cache)

# 注意:MemoryCache 是内存缓存,数据仅在当前进程运行期间有效
# 脚本运行结束后,缓存数据会丢失

缓存生命周期说明:

  • MemoryCache 是纯内存缓存,数据存储在进程内存中
  • 缓存数据仅在当前脚本运行期间有效
  • 脚本运行结束后,所有缓存数据会丢失

持久化缓存(PersistentCache)

持久化缓存支持跨进程/跨运行的缓存持久化,数据会保存到本地文件。支持多种存储后端,通过工厂按名称选择。

安装可选依赖:

pip install rquote[persistent]
# 或
uv pip install "rquote[persistent]"

推荐:使用工厂创建(指定后端类型)ttl 单位为,默认 None 表示永久不过期)

from rquote import get_price, create_persistent_cache

# 按后端名称创建,默认路径为 ~/.rquote/cache.{db|jsonl|pkl}
cache = create_persistent_cache(backend='sqlite')
cache = create_persistent_cache(backend='jsonl', path='/tmp/cache.jsonl')  # 需过期可传 ttl=86400(秒)

# 使用缓存
sid, name, df = get_price('sh000001', dd=cache)
cache.close()

兼容旧写法(不指定 backend 时):

from rquote import get_price, PersistentCache

# 不传 backend 时默认用 sqlite;ttl 单位秒,默认 None 即永久不过期
cache = PersistentCache()
cache = PersistentCache(db_path='./my_cache.db')
sid, name, df = get_price('sh000001', dd=cache)
cache.close()

持久化缓存特性:

  • ✅ 跨进程/跨运行持久化:数据保存在本地文件,下次运行仍可使用
  • ✅ 智能数据合并:相同股票的数据会自动合并,key 不包含日期范围
  • ✅ 智能扩展:当请求的日期范围超出缓存时,自动扩展并合并数据
  • ✅ 支持 TTL:可设置缓存过期时间
  • ✅ 多后端:sqlite / jsonl / pickle,均为标准库、无额外依赖,见下方选择维度

后端选择维度

维度 sqlite jsonl pickle
依赖 标准库,无额外依赖 标准库,无额外依赖 标准库
内存占用 低(按需从文件读) 低(按需从文件读) 高(整库常驻内存)
写入方式 单文件、随机写 单文件、整文件重写 单文件、整库序列化
适用场景 通用、嵌入式、内存紧张 通用、可读性好、内存紧张 兼容旧版、小数据量

内存有限时的建议:

  • 优先使用 sqlitejsonl:两者都不会把整份缓存加载进内存,按 key 读写,适合本机内存紧张、树莓派或容器环境。
  • 避免在内存紧张时使用 pickle:每次读写会整体加载/保存字典,数据量大时易 OOM。

主要功能

历史价格数据获取

get_price(i, sdate='', edate='', freq='day', days=320, fq='qfq', dd=None)

获取股票、基金、期货的历史价格数据

参数:

  • i: 股票代码,使用新浪/腾讯的id形式
  • sdate: 开始日期 (可选,格式:YYYY-MM-DD)
  • edate: 结束日期 (可选,格式:YYYY-MM-DD)
  • freq: 频率,默认'day' (日线),可选:(港A)'week', 'month', (美股)'min'
  • days: 获取天数,默认320天
  • fq: 复权方式,默认'qfq' (前复权),可选:'hfq' (后复权)
  • dd: 本地缓存字典 (可选,已废弃,建议使用MemoryCache)

代码格式说明:

  • A股: sh000001表示上证指数,sz000001表示深市000001股票平安银行
  • ETF: sh510050表示上证50指数ETF
  • 港股: hk00700表示港股腾讯
  • 期货: 需加fu前缀,如fuAP2110fuBTC表示比特币
  • 美股: 需加对应交易所后缀,如usBABA.NusC.NusAAPL.OQ
  • 比特币:使用fuBTC代码

示例:

from rquote import get_price

# 获取上证指数数据
sid, nm, df = get_price('sh000001')
print(df.head())

# 获取指定日期范围的数据
sid, nm, df = get_price('sz000001', sdate='2024-01-01', edate='2024-02-01')

# 获取比特币数据
sid, nm, df = get_price('fuBTC')

# 获取期货分钟数据
sid, nm, df = get_price('fuM2601', freq='min')

返回数据格式:

date open close high low vol
2024-02-06 2680.48 2789.49 2802.93 2669.67 502849313
2024-02-07 2791.51 2829.70 2829.70 2770.53 547117439

get_price_longer(i, l=2, edate='', freq='day', fq='qfq', dd=None)

获取更长时间的历史数据,默认获取2年数据,并且参数与 get_price 保持一致

from rquote import get_price_longer

# 获取3年的历史数据(默认日线、前复权,以最新交易日为结束)
sid, nm, df = get_price_longer('sh000001', l=3)

# 指定结束日期与频率(例如获取到 2024-02-01 的周线数据)
sid, nm, df = get_price_longer('sh000001', l=3, edate='2024-02-01', freq='week', fq='qfq')

股票列表获取

get_cn_stock_list(money_min=2e8)

获取A股股票列表,按成交额排序,默认筛选成交额大于2亿的股票

from rquote import get_cn_stock_list

# 获取成交额大于5亿的股票列表
stocks = get_cn_stock_list(money_min=5e8)
# 返回格式: [{code, name, pe_ttm, volume, turnover/亿, ...}, ...]

get_hk_stocks_500()

获取港股前500只股票列表(按当日成交额排序)

from rquote import get_hk_stocks_500

stocks = get_hk_stocks_500()
# 返回格式: [[code, name, price, -, -, -, -, volume, turnover, ...], ...]

get_us_stocks(k=100)

获取美股最大市值的k支股票列表

from rquote import get_us_stocks

us_stocks = get_us_stocks(k=100)  # 获取前100只
# 返回格式: [{name, symbol, market, mktcap, pe, ...}, ...]

get_cnindex_stocks(index_type='hs300')

获取中国指数成分股列表

from rquote import get_cnindex_stocks

# 获取沪深300成分股
hs300_stocks = get_cnindex_stocks('hs300')
# 获取中证500成分股
zz500_stocks = get_cnindex_stocks('zz500')
# 获取中证1000成分股
zz1000_stocks = get_cnindex_stocks('zz1000')

# 返回格式: [{SECURITY_CODE, SECURITY_NAME_ABBR, INDUSTRY, WEIGHT, EPS, BPS, ROE, FREE_CAP, ...}, ...]

支持的指数类型:

  • 'hs300': 沪深300
  • 'sz50': 上证50
  • 'zz500': 中证500
  • 'kc500': 科创500
  • 'zz1000': 中证1000
  • 'zz2000': 中证2000

基金和期货

get_cn_fund_list()

获取A股ETF基金列表,按成交额排序

from rquote import get_cn_fund_list

funds = get_cn_fund_list()
# 返回格式: [code, name, change, amount, price]

get_cn_future_list()

获取国内期货合约列表

from rquote import get_cn_future_list

futures = get_cn_future_list()
# 返回格式: ['fuSC2109', 'fuRB2110', 'fuHC2110', ...]

板块和概念

get_all_industries()

获取所有行业板块列表

from rquote import get_all_industries

industries = get_all_industries()
# 返回格式: [code, name, change, amount, price, sina_sw2_id]

get_stock_concepts(i)

获取指定股票所属的概念板块

from rquote import get_stock_concepts

# 获取平安银行的概念板块
concepts = get_stock_concepts('sz000001')
# 返回概念代码列表,如 ['BK0420', 'BK0900', ...]

get_stock_industry(i)

获取指定股票所属的行业板块

from rquote import get_stock_industry

# 获取平安银行的行业板块
industries = get_stock_industry('sz000001')

get_industry_stocks(node)

获取指定行业板块的股票列表

from rquote import get_industry_stocks

# 获取行业板块股票
stocks = get_industry_stocks('sw2_480200')

实时行情

get_tick(tgts=[])

获取实时行情数据

from rquote import get_tick

# 获取美股实时行情
tick_data = get_tick(['AAPL', 'GOOGL'])
# 返回格式: [{'name': 'Apple Inc', 'price': '150.25', 'price_change_rate': '1.2%', ...}]

可视化工具

PlotUtils.plot_candle(i, sdate='', edate='', dsh=False, vol=True)

绘制K线图

from rquote import PlotUtils
import plotly.graph_objs as go

# 绘制平安银行的K线图
data, layout = PlotUtils.plot_candle('sz000001', sdate='2024-01-01', edate='2024-02-01')

# 使用plotly显示
fig = go.Figure(data=data, layout=layout)
fig.show()

高级功能

配置管理

from rquote import config

# 使用默认配置
default_config = config.default_config

# 创建自定义配置
custom_config = config.Config(
    http_timeout=15,
    http_retry_times=5,
    cache_enabled=True,
    cache_ttl=7200  # 单位:秒
)

# 从环境变量创建配置
import os
os.environ['RQUOTE_HTTP_TIMEOUT'] = '20'
config_from_env = config.Config.from_env()

日志配置

默认情况下,日志功能是关闭的。 如果需要启用日志,可以通过环境变量手动开启:

通过环境变量开启日志

# 设置日志级别为 INFO(会同时输出到文件和控制台)
export RQUOTE_LOG_LEVEL=INFO

# 可选:自定义日志文件路径(默认为 /tmp/rquote.log)
export RQUOTE_LOG_FILE=/path/to/your/logfile.log

# 然后运行你的Python脚本
python your_script.py

支持的日志级别

  • DEBUG: 详细的调试信息
  • INFO: 一般信息(推荐)
  • WARNING: 警告信息
  • ERROR: 错误信息
  • CRITICAL: 严重错误

在Python代码中开启日志

import os

# 在导入 rquote 之前设置环境变量
os.environ['RQUOTE_LOG_LEVEL'] = 'INFO'
os.environ['RQUOTE_LOG_FILE'] = '/tmp/rquote.log'  # 可选

from rquote import get_price

# 现在日志已启用
sid, name, df = get_price('sh000001')

关闭日志

如果不设置 RQUOTE_LOG_LEVEL 环境变量,或者设置为空值,日志功能将保持关闭状态(默认行为)。

使用改进的HTTP客户端

from rquote.utils.http import HTTPClient

# 创建HTTP客户端
with HTTPClient(timeout=15, retry_times=3) as client:
    response = client.get('https://example.com')
    if response:
        print(response.text)

使用缓存

from rquote.cache import MemoryCache

# 创建缓存(ttl 单位:秒)
cache = MemoryCache(ttl=3600)  # 缓存 1 小时

# 使用缓存
cache.put('key1', 'value1')
value = cache.get('key1')
cache.delete('key1')
cache.clear()  # 清空所有缓存

异常处理

from rquote import get_price
from rquote.exceptions import SymbolError, DataSourceError, NetworkError

try:
    sid, name, df = get_price('invalid_symbol')
except SymbolError as e:
    print(f"股票代码错误: {e}")
except DataSourceError as e:
    print(f"数据源错误: {e}")
except NetworkError as e:
    print(f"网络错误: {e}")

工具类

WebUtils

网络请求工具类

from rquote import WebUtils

# 获取随机User-Agent
ua = WebUtils.ua()

# 获取请求头
headers = WebUtils.headers()

# 测试代理
result = WebUtils.test_proxy('127.0.0.1:8080')

BasicFactors

基础因子计算工具类

from rquote import BasicFactors
import pandas as pd

# 假设df是价格数据DataFrame
# break_rise: 突破上涨
break_rise = BasicFactors.break_rise(df)

# min_resist: 最小阻力
min_resist = BasicFactors.min_resist(df)

# vol_extreme: 成交量极值
vol_extreme = BasicFactors.vol_extreme(df)

# bias_rate_over_ma60: 偏离MA60的比率
bias_rate = BasicFactors.bias_rate_over_ma60(df)

# op_ma: MA评分
ma_score = BasicFactors.op_ma(df)

架构改进

新版本改进

v0.3.5 主要改进:

  1. 修复Critical Bugs

    • 修复了 WebUtils.http_get 中的 cls.ua bug
    • 修复了 test_proxy 方法中的逻辑错误
    • 改进了异常处理
  2. 新增模块化架构

    • 配置管理模块 (config.py)
    • 异常处理体系 (exceptions.py)
    • 缓存抽象层 (cache/)
    • 数据源抽象层 (data_sources/)
    • 改进的HTTP客户端 (utils/http.py)
  3. 向后兼容

    • 所有原有API保持不变
    • 新增功能为可选使用

目录结构

rquote/
├── __init__.py              # 公共API导出
├── config.py                # 配置管理
├── exceptions.py             # 异常定义
├── main.py                   # 主要功能(向后兼容)
├── utils.py                  # 工具类(向后兼容)
├── plots.py                  # 绘图工具
├── cache/                    # 缓存模块
│   ├── __init__.py
│   ├── base.py              # 缓存基类
│   └── memory.py            # 内存缓存实现
├── data_sources/             # 数据源模块
│   ├── __init__.py
│   ├── base.py              # 数据源基类
│   ├── sina.py              # 新浪数据源
│   └── tencent.py           # 腾讯数据源
├── parsers/                  # 数据解析模块
│   ├── __init__.py
│   └── kline.py             # K线数据解析
└── utils/                    # 工具模块
    ├── __init__.py
    ├── http.py              # HTTP客户端
    └── date.py               # 日期工具

测试

运行单元测试:

# 运行所有测试
python -m pytest tests/

# 运行特定测试
python -m pytest tests/test_utils.py
python -m pytest tests/test_cache.py
python -m pytest tests/test_config.py
python -m pytest tests/test_exceptions.py
python -m pytest tests/test_api.py

注意事项

  1. 数据来源: 数据来源于新浪财经、腾讯财经、东方财富等公开数据源
  2. 请求频率: 建议合理控制请求频率,避免被限制访问
  3. 代码格式:
    • 期货代码需要加fu前缀,如fuAP2110
    • 美股代码需要加对应后缀,如usAAPL.OQ (OQ->NASDAQ, N->NYSE, AM->ETF)
  4. 网络要求: 部分功能需要网络连接,请确保网络畅通
  5. 缓存使用: 建议使用缓存机制减少网络请求,提升性能

贡献

欢迎提交Issue和Pull Request!

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

rquote-0.5.8.tar.gz (49.6 kB view details)

Uploaded Source

Built Distribution

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

rquote-0.5.8-py3-none-any.whl (53.9 kB view details)

Uploaded Python 3

File details

Details for the file rquote-0.5.8.tar.gz.

File metadata

  • Download URL: rquote-0.5.8.tar.gz
  • Upload date:
  • Size: 49.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for rquote-0.5.8.tar.gz
Algorithm Hash digest
SHA256 422056c58af7bc6a0650bc9b548bb9400f8d1c73fab7e65ec98c484f6a5749a1
MD5 f05eba921928b0024bd81ceca9e28c5b
BLAKE2b-256 4351503a39229843df34d676b587c4f081422c13f717383ccbef16976ad00305

See more details on using hashes here.

File details

Details for the file rquote-0.5.8-py3-none-any.whl.

File metadata

  • Download URL: rquote-0.5.8-py3-none-any.whl
  • Upload date:
  • Size: 53.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for rquote-0.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d0816918ecdad2eb0e4cffef84b62a739b6c595a8705d8fefc06d7e7e33a1909
MD5 51a1c911dadd7a1ba79771c0ff44f2d0
BLAKE2b-256 28358f68c456caa9886ae18188a00d199b7f26a52d96e547e2386730ea36b3ec

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