rqalpha-futu-datasource 1.1.0

Futu datasource for rqalpha

rqalpha-futu-datasource

由于RQAlpha回测框架提供的数据，需要付费(还挺贵)，并且只有A股的数据。 因此为RQAlpha框架提供自定义的Futu(富途)数据源，同时支持A股、港股、美股数据。用于基于rqalpha框架的股票回测。

用法

本地开发

推荐使用uv工具管理项目依赖。执行以下命令安装项目依赖：

make sync

后续即可做开发和测试。

安装

• pip install rqalpha-futu-datasource

下载富途原始数据到本地

• 启动本地 OpenD(默认 127.0.0.1:11111)
• 运行下载脚本，将数据保存为 CSV：
  • python -m rqalpha_futu_datasource.download --data-dir data --codes 000001.XSHE,600000.XSHG,00700.XHKG,US.AAPL --periods 1m,3m,5m,1d,1w --start 2024-01-01 --end 2024-12-31
  • 或使用代码文件：python -m rqalpha_futu_datasource.download --data-dir data --code-file ./codes.txt
• 目录结构：data/<MARKET>/<SYMBOL>/<period>.csv，例如：data/SZ/000001/1d.csv
• 可通过环境变量指定目录：set FUTU_DATA_DIR=...（Windows）

注意：

• 下载富途原始数据时，也可以指定富途OpenD的地址和端口号，如"--host 192.168.0.2 --port 22222"
• 为了使用方便，--codes的格式同时支持富途的股票代码格式（如 SZ.000001、SH.600000、HK.00700、US.AAPL）与 RQAlpha 的股票代码格式（如 000001.XSHE、600000.XSHG、00700.XHKG、AAPL.XNAS）。
• 同时，--code-file参数也支持同时包含这两种格式的股票代码，每个股票代码占一行。
• 但回测代码里面的股票代码格式，必须是 RQAlpha 格式（如 000001.XSHE、600000.XSHG、00700.XHKG、AAPL.XNAS）。

在 RQAlpha 中启用 Futu 数据源

通过扩展模块替换默认DataSource。参考：test_rqalpha.py, mod_futu_ds.py

1. 基础配置

from rqalpha import run_func


def test_run_with_futu_datasource():
    config = {
        "base": {
            "start_date": "2024-11-01",
            "end_date": "2024-11-06",
            "accounts": {"stock": 100000},
            "frequency": "1m",
            "data_bundle_path": os.path.abspath("tests/data"),
        },
        "extra": {
            "log_level": "info",
        },
        "mod": {
            "futu_ds": {
                "enabled": True,
                "lib": "rqalpha_futu_datasource.mod_futu_ds",
            }
        },
    }
    run_func(init=init, handle_bar=handle_bar, config=config)

2. 配置港股每手（Board Lot）

为避免网络依赖，港股每手数量支持以本地方式配置。如果不配置港股每手映射表，默认每手为100。支持以下两种方式（优先使用内存字典）：

• 通过 CSV 文件路径：配置 hk_lot_map_path。CSV 需包含 code 与 lot_size（或 lot/board_lot）列。
• 通过内存字典：配置 hk_lot_map。

配置示例：

config = {
    "mod": {
        "futu_ds": {
            "enabled": True,
            "lib": "rqalpha_futu_datasource.mod_futu_ds",
            # 方式一：指定 CSV 文件路径
            "hk_lot_map_path": os.path.abspath("tests/data/hk_lot_map.csv"),
            # 方式二：直接传入字典 (优先级更高)
            "hk_lot_map": {"00700": 200, "00005": 500},
        }
    },
}

CSV 文件示例：

code,lot_size
00700,200
00005,500

3. 配置交易日历范围（Markets）

rqalpha-futu-datasource 需要知道在哪个市场中查找交易日历数据。这可以通过以下两种方式确定：

1. 通过 sys_analyser 的 benchmark 配置（推荐）： 如果配置了 benchmark（基准），数据源会自动推断 benchmark 所在的市场，并使用该市场的交易日历。

   config = {
       "mod": {
           "sys_analyser": {
               "enabled": True,
               "benchmark": "000001.XSHE",  # 自动推断为 SZ 市场
           },
           "futu_ds": {
               "enabled": True,
               # ... 其他配置
           }
       }
   }
   

2. 通过 markets 显式配置： 如果没有配置 benchmark，或者需要加载多个市场的日历数据，可以在 futu_ds 中显式指定 markets 列表。

   config = {
       "mod": {
           "futu_ds": {
               "enabled": True,
               # 显式指定需要扫描的市场，如 ["SZ", "SH", "HK", "US"]
               "markets": ["SZ", "SH", "HK"], 
               # ... 其他配置
           }
       }
   }
   

注意：如果既没有配置 benchmark 也没有配置 markets，数据源初始化时会抛出错误。

指定富途数据存储目录有三种方式

1. 在RQAlpha的模块配置中指定：

   config = {
      "mod": {
            "futu_ds": {
                "enabled": True,
                "lib": "rqalpha_futu_datasource.mod_futu_ds",
                "futu_data_dir": "path/to/futu/data",
            }
        },
   }
   

2. 在RQAlpha base配置中指定：

   config = {
       "base": {
           "data_bundle_path": "path/to/futu/data",
       },
   }
   

3. 在环境变量中指定：

   export FUTU_DATA_DIR=path/to/futu/data
   

优先级按此顺序：模块配置 > base配置 > 环境变量。

限制及说明

• RQAlpha与富途股票代码之间的对应关系是：
  • A股：000001.XSHE -> SZ.000001 (深圳交易所)
  • A股：603728.XSHG -> SH.603728 (上海交易所)
  • 港股：00700.XHKG -> HK.00700 (香港交易所)
  • 美股：AAPL.XNAS -> US.AAPL (纳斯达克交易所)
  • 美股：TSM.XNYS -> US.TSM (纽约交易所)
• 限制：
  • 仅支持股票数据，不支持期货、期权等其他品种。
  • 原始从富途下载的数据就只能是股票前复权数据。不支持其他复权方式。
  • 数据不能增量更新，有新数据需求只能重新下载全量数据(富途的OpenD进程会本地缓存数据，所以不用太担心此问题)。
  • 回测频率支持周期 1m、1d(RQAlpha框架限制)，在handle_bar回调函数中，可以查询的历史数据周期为:1m, 3m, 5m, 1d, 1w(RQAlpha框架限制，无法支持到月级别)。