RQAlpha_structure 思维导图模板_ProcessOn思维导图、流程图

数据源

DefaultDataBundle

trading_dates

交易日数据

DailyStock

股票日线数据

original_dividends

未复权数据

adjusted_dividends

前复权数据

indexes

指数数据

st_stocks

st股票数据

suspended_stocks

停牌股票数据

DailyFuture

期货日线数据

DailyFunds

基金日线数据

Instruments

合约信息数据

YieldCurve

国债利率数据

AbstractDataSource

get_all_instruments

获取所有Instruments

get_trading_calendar

获取交易日历

get_yield_curve

获取国债利率

get_dividend

获取股票/基金分红信息

get_split

获取拆股信息

get_bar

*根据datetime获取相应的Bar数据

get_settle_price

获取期货品种对应日期的结算价

history_bars

获取历史数据

current_snapshot

获取当前市场快照数据

get_trading_minutes_for

获取证券某天的交易时段

available_data_range

获取数据源能提供的数据对应的时间范围

RealtimeDataSource

StockDataSource

https://github.com/ricequant/rqalpha/blob/master/rqalpha/mod/rqalpha_mod_sys_stock_realtime/README.rst

CTPDataSource

https://github.com/ricequant/rqalpha-mod-vnpy

事件源

AbstractEventSource

events

BEFORE_TRADING

每天交易前触发该事件

BAR

每个Bar触发该事件

TICK

每个Tick触发该事件

AFTER_TRADING

每天交易结束后触发该事件

SETTLEMENT

每天结算时触发该事件

RealtimeEventSource

StockEventSource(TODO)

FutureEventSource(TODO)

FutureEventSourceOnTick(TODO)

EventBus

事件控制器

add_listener

在事件监听队列末尾添加事件监听

prepend_listener

在事件监听队列头添加事件监听

publish_event

发布并广播事件

Events

SystemEvent

系统事件

POST_SYSTEM_INIT

系统初始化后触发

POST_USER_INIT

策略执行完init函数后触发

MarketEvent

POST_UNIVERSE_CHANGED

策略证券池发生变化后触发

PRE_BEFORE_TRADING

执行before_trading函数前触发

BEFORE_TRADING

该事件会触发策略的before_trading函数

POST_BEFORE_TRADING

执行before_trading函数后触发

PRE_BAR

执行handle_bar函数前触发

BAR

该事件会触发策略的handle_bar函数

POST_BAR

执行handle_bar函数后触发

PRE_TICK

执行handle_tick前触发

TICK

该事件会触发handle_tick函数

POST_TICK

执行handle_tick后触发

PRE_SCHEDULED

在scheduler执行前触发

POST_SCHEDULED

在scheduler执行后触发

PRE_AFTER_TRADING

执行after_trading函数前触发

AFTER_TRADING

该事件会触发策略的after_trading函数

POST_AFTER_TRADING

执行after_trading函数后触发

PRE_SETTLEMENT

结算前触发该事件

SETTLEMENT

触发结算事件

POST_SETTLEMENT

结算后触发该事件

OrderEvent

ORDER_PENDING_NEW

创建订单

ORDER_CREATION_PASS

创建订单成功

ORDER_CREATION_REJECT

创建订单失败

ORDER_PENDING_CANCEL

创建撤单

ORDER_CANCELLATION_PASS

撤销订单成功

ORDER_CANCELLATION_REJECT

撤销订单失败

ORDER_UNSOLICITED_UPDATE

订单状态更新

TRADE

成交

Mod管理

ModHandler

Mod管理器

environment

mod_dict

AbstractMod

start_up

系统启动后加载Mod会调用该接口

tear_down

系统退出前会调该接口来执行Mod的退出相关清理工作

load_mod

自定义Mod的入口函数

Mod Manager

查看当前 Mod 列表

rqalpha mod list

以使用 rqalpha-mod-sentry 为例

安装 Mod

rqalpha mod install sentry

卸载 Mod

rqalpha mod uninstall sentry

启用 Mod

rqalpha mod enable sentry

禁用 Mod

rqalpha mod disable sentry

配置信息

whitelist

白名单，设置可以在策略代码中指定哪些模块可以通过__config__进行配置

base

基础配置信息

data_bundle_path

数据源存储的路径

strategy_file

启动策略的文件路径

start_date

回测起始日期

end_date

回测结束日期

stock_starting_cash

股票起始资金

future_starting_cash

期货起始资金

securities

策略可交易品种

run_type

运行类型(回测/模拟交易/实盘)

frequency

周期(默认为1d - DayBar)

benchmark

基准参照

margin_multiplier

保证金乘数

resume_mode

开启resume模式

persist

开启persist模式

persist_mode

persist方式

extra

log_level

日志输出等级

user_system_log_disabled

是否关闭用户策略代码中输出的日志

context_vars

策略自定义参数设置

force_run_init_when_pt_resume

resume但强制执行init函数

enable_profiler

开启profiler性能分析

is_hold

locale

本地化

validator

cash_return_by_stock_delisted

回测中，退市/交割后自动返还现金

close_amount

执行order_value时，进行实际下单数量的校验和scale

mod

sys_analyser

数据分析、风险度分析、数据输出模块

record

当不输出csv/pickle/plot 等内容时，可以通过 record 来决定是否执行该 Mod 的计算逻辑

output_file

如果指定路径，则输出计算后的 pickle 文件

report_save_path

如果指定路径，则输出 report csv 文件

plot

画图

plot_save_file

如果指定路径，则输出 plot 对应的图片文件

sys_funcat

支持基于funcat的技术分析的API

sys_progress

命令行查看进度条

show

显示进度条

sys_risk

风控模块

validate_price

检查限价单价格是否合法

validate_is_trading

检查证券是否可以交易

validate_cash

检查可用资金是否充足

validate_position

检查可平仓位是否充足

sys_simulation

模拟交易模块

signal

是否开启信号模式

matching_type

启用的撮合引擎模式

slippage

设置滑点

commission_multiplier

手续费乘数

price_limit

在处于涨跌停时，无法买进/卖出，默认开启

【在 Signal 模式下，不再禁止买进/卖出，如果开启，则给出警告提示。】

liquidity_limit

当对手盘没有流动性的时候，无法买进/卖出，默认关闭

volume_limit

是否有成交量限制

volume_percent

当成交量限制开启时，允许当前下单所占用的最大成交量占比

sys_stock_realtime

接收实时行情运行

持久化

AbstractPersistProvider

store

持久化数据

load

恢复数据

DiskPersistProvider

以本地文件的方式进行持久化

也可扩展为基于Redis/db/HTTP等方式进行持久化

Persistable

有持久化需求的模块可以继承该接口，实现get_state/set_state函数即可

get_state

序列化数据

set_state

反序列化数据

交易柜台代理

AbstractBroker

get_accounts

获取并生成账户信息

submit_order

提交订单

cancel_order

撤销订单

get_open_orders

获取当前未完成订单

before_trading

会在BEFORE_TRADING事件触发时调用

after_trading

会在AFTER_TRADING事件触发时调用

update

会在事件触发时调用

RealBroker

CTPBroker

https://github.com/ricequant/rqalpha-mod-vnpy

StockBroker

https://github.com/ricequant/rqalpha/blob/master/rqalpha/mod/rqalpha_mod_sys_stock_realtime/README.rst

Account

portfolio

仓位组合

positions

仓位

daily_orders

当日订单

daily_trades

当日成交

Matcher

撮合引擎

order matching

order events triggering

Environment

config

配置信息

data_proxy

数据源代理

data_source

数据源

price_board

获取当前快照数据

event_source

事件源

strategy_loader

策略加载器

global_vars

参数调优预定义变量

universe

策略运行中的证券池

portfolio

投资组合(其中包含了账户/持仓等相关内容)

event_bus

事件处理器

calendar_dt

当前日历datetime

trading_dt

当前交易datetime

mod_dict

包含所有已加载mod的字典

API

Strategy

AbstractStrategyLoader

strategy

可以是策略文件路径

可以是策略文件代码

也可以扩展http/token/加密等方式加载策略

scope

RQAlphaAPIScope

ExtendAPIScope

可以通过扩展scope进行API的扩展

API

api_base

通用API

api_stock

股票专用API

api_future

期货专用API

handle_tick

api_funcat(TODO)

StrategyContext

策略上下文

universe

策略运行中的证券池

now

当前时间

run_info

策略运行相关信息

portfolio

总仓位组合

stock_account

股票仓位组合

future_account

期货仓位组合

config

配置信息

universe

策略运行中的证券池

init

执行策略定义的init函数

before_trading

执行策略定义的before_trading函数

handle_bar

执行策略定义的handle_bar函数

handle_tick

执行策略定义的handle_tick函数

after_trading

执行策略定义的after_trading函数

策略API

基本方法

init(context)

策略初始化函数

handle_bar(context, bar_dict)

bar数据更新时会自动触发

handle_tick(context, tick)

tick数据更新时自动触发

before_trading(context)

每日交易开始前触发

after_trading(context)

每日交易结束后开始触发

交易相关函数

order

【通用】智能下单函数

order_to

【通用】智能调仓函数

order_shares

【股票】指定股数交易

order_lots

【股票】指定手数交易

order_value

【股票】指定价值交易

order_percent

【股票】指定比例交易

order_target_value

【股票】目标价值下单

order_target_percent

【股票】目标比例下单

buy_open

【期货】买开

sell_close

【期货】卖平

sell_open

【期货】卖开

buy_close

【期货】买平

更多 API 请访问: http://rqalpha.io/zh_CN/latest/api/base_api.html

多种方式运行策略

命令行运行

rqalpha run -f strategy.py

命令行指定配置文件运行

rqalpha run --config .config.yml

策略内配置参数信息运行

通过引用 RQAlpha 库在代码中运行

run_file(strategy_file, config)

指定配置文件路径来运行

run_code(code, config)

指定策略代码来运行

run_func(**kwargs)

传入指定函数来运行

系统API

from rqalpha import cli

扩展命令行

详情请参考: http://rqalpha.io/zh_CN/latest/intro/run_algorithm.html#id4

from rqalpha import export_as_api

扩展 API

详情请参考: http://rqalpha.io/zh_CN/latest/development/data_source.html#api

获取版本信息

from rqalpha import __version__

from rqalpha import version_info

from rqalpha import update_bundle

更新数据源

from rqalpha import run_file

通过指定策略文件路径来运行策略

from rqalpha import run_code

通过指定策略代码来运行策略

from rqalpha import run_func

通过传入策略函数来运行

from rqalpha import subscribe_event

注册事件进行扩展

扩展Interface

AbstractStrategyLoader

策略加载器

AbstractEventSource

事件源接口

AbstractPriceBoard

行情快照接口

AbstractDataSource

数据源接口

AbstractBroker

券商Gateway接口

AbstractMod

扩展Mod接口

AbstractPersistProvider

持久化服务接口

AbstractFrontendValidator

前端风控接口