Futu_Algo 开源项目安装与使用教程
项目概述
Futu_Algo
是一个基于富途OpenAPI开发的算法交易解决方案,专为富途牛牛和富途喵喵的香港股市用户设计。它支持历史数据下载、回测交易策略、实时低延迟交易、自定义股票筛选器以及即将推出的图形界面。本教程将引导您了解项目的核心组件,包括其目录结构、启动文件和配置文件的详细信息。
1. 目录结构及介绍
.
├── environment.yml # Conda环境配置文件
├── main.py # 图形界面启动脚本(未来功能)
├── main_backend.py # 后端主程序,用于执行交易逻辑和数据处理
├── requirements.txt # 当使用pip时,项目依赖文件
├── setup.py # Python包安装脚本
├── CODE_OF_CONDUCT.md # 行为准则
├── LICENSE # 许可证文件,采用Apache-2.0
├── README.md # 项目的主要读我文件,包含详细指南
└── config.ini # 配置模板,包含连接设置和偏好设置
├── ... # 其他子目录如data, engines, strategies等,分别存放数据、交易引擎和策略相关代码
每个子目录按功能划分,例如engines
存放交易引擎实现,strategies
包含不同的交易策略代码。
2. 项目启动文件介绍
主要后端启动文件:main_backend.py
用于执行交易策略、更新历史数据、进行回测等功能。通过命令行参数控制不同操作,例如更新数据、执行特定策略等。示例命令:
- 更新历史数据:
python main_backend.py --force_update
- 执行MACD交叉策略交易:
python main_backend.py --strategy MACD_Cross
图形界面启动文件:main.py(待完成)
未来版本将包含一个易用的GUI,目前此文件暂时不可用于实际应用。
3. 项目配置文件介绍
config.ini 是核心配置文件,分为多个部分来适应不同的设定需求:
[FutuOpenD_Config]
设置富途OpenD连接信息,包括Host, Port, WebSocketPort, WebSocketKey和TrdEnv(模拟或实盘)。[FutuOpenD_Credential]
用户名和密码MD5值,用于登录认证。[FutuOpenD_DataFormat]
定义了历史数据和订阅数据的字段格式。[TradePreference]
包括每笔信号购买的股票数量、每个资产的最大资金分配比例及股票列表。[Backtesting_Commission_HK]
港股交易的佣金设置。[Email]
邮件服务设置,用于股票筛选结果的通知。[TuShare_Credential]
TuShare API的token,用于额外的数据获取。
重要提示: 确保在使用前根据个人需求修改config.ini
中的敏感信息,并参照最新的README,因为配置格式可能会随项目更新而变化。
遵循以上介绍,您可以顺利地配置并开始利用Futu_Algo
进行算法交易实验和实盘操作。记得仔细阅读项目文档和指南,以充分利用项目的所有功能。