基础 API

约定函数

init - 策略初始化

init(context)

初始化方法 - 在回测和实时模拟交易只会在启动的时候触发一次。你的算法会使用这个方法来设置你需要的各种初始化配置。 context 对象将会在你的算法的所有其他的方法之间进行传递以方便你可以拿取到。

参数

context (StrategyContext object) – 策略上下文

Example

def init(context):
    # cash_limit的属性是根据用户需求自己定义的,你可以定义无限多种自己随后需要的属性,ricequant的系统默认只是会占用context.portfolio的关键字来调用策略的投资组合信息
    context.cash_limit = 5000

handle_bar - k 线数据更新

handle_bar(context, bar_dict)

bar数据的更新会自动触发该方法的调用。策略具体逻辑可在该方法内实现,包括交易信号的产生、订单的创建等。 在实时模拟交易中,该函数在交易时间内会每分钟被触发一次。

参数
  • context (StrategyContext object) – 策略上下文

  • bar_dict (Dict[BarObject]) – key 为 order_book_id,value 为 bar 对象

Example

def handle_bar(context, bar_dict):
    # put all your algorithm main logic here.
    # ...
    order_shares('000001.XSHE', 500)
    # ...

handle_tick - 快照数据更新

handle_tick(context, tick)

在 tick 级别的策略中,已订阅快照数据的更新会自动触发该方法的调用。策略具体逻辑可在该方法内实现,包括交易信号的产生、订单的创建等。 若订阅了多个合约,不同合约快照数据的更新会分别触发该方法。

参数
  • context (StrategyContext object) – 策略上下文

  • tick (TickObject object) – key为order_book_id,value为bar数据。当前合约池内所有合约的bar数据信息都会更新在bar_dict里面

Example

def handle_bar(context, tick):
    # put all your algorithm main logic here.
    # ...
    order_shares(tick.order_book_id, tick.last)
    # ...

open_auction - 集合竞价

open_auction(context, bar_dict)

盘前集合竞价发生时会触发该函数的调用,在该函数内发出的订单会以当日开盘价被撮合。

参数
  • context (StrategyContext object) – 策略上下文

  • bar_dict (Dict[BarObject]) – key 为 order_book_id,value 为 不完整的 bar 对象,该对象仅有 open, limit_up, limit_down 等字段,没有 close 等字段

Example

def open_auction(context, bar_dict):
    # put all your algorithm main logic here.
    # ...
    order_book_id = "000001.XSHE"
    order_shares(order_book_id, bar_dict[order_book_id].open)
    # ...

before_trading - 盘前

before_trading(context)

每天在策略开始交易前会被调用。不能在这个函数中发送订单。需要注意,该函数的触发时间取决于用户当前所订阅合约的交易时间。

举例来说,如果用户订阅的合约中存在有夜盘交易的期货合约,则该函数可能会在前一日的20:00触发,而不是早晨08:00.

参数

context (StrategyContext object) – 策略上下文

Example

def before_trading(context, bar_dict):
    logger.info("This is before trading")

after_trading - 盘后

after_trading(context)

每天在收盘后被调用。不能在这个函数中发送订单。您可以在该函数中进行当日收盘后的一些计算。

在实时模拟交易中,该函数会在每天15:30触发。

参数

context (StrategyContext object) – 策略上下文

交易接口

submit_order - 自由参数下单「通用」

rqalpha.api.submit_order(id_or_ins, amount, side, price=None, position_effect=None)[源代码]

通用下单函数,策略可以通过该函数自由选择参数下单。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (float) – 下单量,需为正数

  • side (SIDE) – 多空方向

  • price (Optional[float]) – 下单价格,默认为None,表示市价单

  • position_effect (Optional[POSITION_EFFECT]) – 开平方向,交易股票不需要该参数

Example

# 购买 2000 股的平安银行股票,并以市价单发送:
submit_order('000001.XSHE', 2000, SIDE.BUY)
# 平 10 份 RB1812 多方向的今仓,并以 4000 的价格发送限价单
submit_order('RB1812', 10, SIDE.SELL, price=4000, position_effect=POSITION_EFFECT.CLOSE_TODAY)
返回类型

Optional[Order]

order - 智能下单「通用」

rqalpha.api.order(order_book_id, quantity, price=None, style=None)[源代码]

全品种通用智能调仓函数

如果不指定 price, 则相当于下 MarketOrder

如果 order_book_id 是股票,等同于调用 order_shares

如果 order_book_id 是期货,则进行智能下单:

  • quantity 表示调仓量

  • 如果 quantity 为正数,则先平 Sell 方向仓位,再开 Buy 方向仓位

  • 如果 quantity 为负数,则先平 Buy 反向仓位,再开 Sell 方向仓位

参数
  • order_book_id (Union[str, Instrument]) – 下单标的物

  • quantity (int) – 调仓量

  • price (Optional[float]) – 下单价格

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

1
2
3
4
5
6
# 当前仓位为0
# RB1710 多方向调仓2手:调整后变为 BUY 2手
order('RB1710', 2)

# RB1710 空方向调仓3手:先平多方向2手 在开空方向1手,调整后变为 SELL 1手
order('RB1710', -3)
返回类型

List[Order]

order_to - 智能下单「通用」

rqalpha.api.order_to(order_book_id, quantity, price=None, style=None)[源代码]

全品种通用智能调仓函数

如果不指定 price, 则相当于 MarketOrder

如果 order_book_id 是股票,则表示仓位调整到多少股

如果 order_book_id 是期货,则进行智能调仓:

  • quantity 表示调整至某个仓位

  • quantity 如果为正数,则先平 SELL 方向仓位,再 BUY 方向开仓 quantity 手

  • quantity 如果为负数,则先平 BUY 方向仓位,再 SELL 方向开仓 -quantity 手

参数
  • order_book_id (Union[str, Instrument]) – 下单标的物

  • quantity (int) – 调仓量

  • price (float) – 下单价格

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

1
2
3
4
5
6
# 当前仓位为0
# RB1710 调仓至 BUY 2手
order_to('RB1710', 2)

# RB1710 调仓至 SELL 1手
order_to('RB1710', -1)
返回类型

List[Order]

order_shares - 指定股数交易「股票专用」

rqalpha.api.order_shares(id_or_ins, amount, price=None, style=None)[源代码]

指定股数的买/卖单,最常见的落单方式之一。如有需要落单类型当做一个参量传入,如果忽略掉落单类型,那么默认是市价单(market order)。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (int) – 下单量, 正数代表买入,负数代表卖出。将会根据一手xx股来向下调整到一手的倍数,比如中国A股就是调整成100股的倍数。

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#购买Buy 2000 股的平安银行股票,并以市价单发送:
order_shares('000001.XSHE', 2000)
#卖出2000股的平安银行股票,并以市价单发送:
order_shares('000001.XSHE', -2000)
#购买1000股的平安银行股票,并以限价单发送,价格为¥10:
order_shares('000001.XSHG', 1000, style=LimitOrder(10))
返回类型

Optional[Order]

order_lots - 指定手数交易「股票专用」

rqalpha.api.order_lots(id_or_ins, amount, price=None, style=None)[源代码]

指定手数发送买/卖单。如有需要落单类型当做一个参量传入,如果忽略掉落单类型,那么默认是市价单(market order)。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (int) – 下单量, 正数代表买入,负数代表卖出。将会根据一手xx股来向下调整到一手的倍数,比如中国A股就是调整成100股的倍数。

  • price (float) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#买入20手的平安银行股票,并且发送市价单:
order_lots('000001.XSHE', 20)
#买入10手平安银行股票,并且发送限价单,价格为¥10:
order_lots('000001.XSHE', 10, style=LimitOrder(10))
返回类型

Optional[Order]

order_value - 指定价值交易「股票专用」

rqalpha.api.order_value(id_or_ins, cash_amount, price=None, style=None)[源代码]

使用想要花费的金钱买入/卖出股票,而不是买入/卖出想要的股数,正数代表买入,负数代表卖出。股票的股数总是会被调整成对应的100的倍数(在A中国A股市场1手是100股)。如果资金不足,该API将不会创建发送订单。

需要注意: 当您提交一个买单时,cash_amount 代表的含义是您希望买入股票消耗的金额(包含税费),最终买入的股数不仅和发单的价格有关,还和税费相关的参数设置有关。 当您提交一个卖单时,cash_amount 代表的意义是您希望卖出股票的总价值。如果金额超出了您所持有股票的价值,那么您将卖出所有股票。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • cash_amount (float) – 需要花费现金购买/卖出证券的数目。正数代表买入,负数代表卖出。

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#花费最多¥10000买入平安银行股票,并以市价单发送。具体下单的数量与您策略税费相关的配置有关。
order_value('000001.XSHE', 10000)
#卖出价值¥10000的现在持有的平安银行:
order_value('000001.XSHE', -10000)
返回类型

Optional[Order]

order_percent - 一定比例下单「股票专用」

rqalpha.api.order_percent(id_or_ins, percent, price=None, style=None)[源代码]

发送一个花费价值等于目前投资组合(市场价值和目前现金的总和)一定百分比现金的买/卖单,正数代表买,负数代表卖。股票的股数总是会被调整成对应的一手的股票数的倍数(1手是100股)。百分比是一个小数,并且小于或等于1(<=100%),0.5表示的是50%.需要注意,如果资金不足,该API将不会创建发送订单。

需要注意:

发送买单时,percent 代表的是期望买入股票消耗的金额(包含税费)占投资组合总权益的比例。 发送卖单时,percent 代表的是期望卖出的股票总价值占投资组合总权益的比例。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • percent (float) – 占有现有的投资组合价值的百分比。正数表示买入,负数表示卖出。

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#花费等于现有投资组合50%价值的现金买入平安银行股票:
order_percent('000001.XSHG', 0.5)
返回类型

Optional[Order]

order_target_value - 目标价值下单「股票专用」

rqalpha.api.order_target_value(id_or_ins, cash_amount, price=None, style=None)[源代码]

买入/卖出并且自动调整该证券的仓位到一个目标价值。 加仓时,cash_amount 代表现有持仓的价值加上即将花费(包含税费)的现金的总价值。 减仓时,cash_amount 代表调整仓位的目标价至。

需要注意,如果资金不足,该API将不会创建发送订单。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • cash_amount (float) – 最终的该证券的仓位目标价值。

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#如果现在的投资组合中持有价值¥3000的平安银行股票的仓位,以下代码范例会发送花费 ¥7000 现金的平安银行买单到市场。(向下调整到最接近每手股数即100的倍数的股数):
order_target_value('000001.XSHE', 10000)
返回类型

Optional[Order]

order_target_percent - 目标比例下单「股票专用」

rqalpha.api.order_target_percent(id_or_ins, percent, price=None, style=None)[源代码]

买入/卖出证券以自动调整该证券的仓位到占有一个目标价值。

加仓时,percent 代表证券已有持仓的价值加上即将花费的现金(包含税费)的总值占当前投资组合总价值的比例。 减仓时,percent 代表证券将被调整到的目标价至占当前投资组合总价值的比例。

其实我们需要计算一个position_to_adjust (即应该调整的仓位)

position_to_adjust = target_position - current_position

投资组合价值等于所有已有仓位的价值和剩余现金的总和。买/卖单会被下舍入一手股数(A股是100的倍数)的倍数。目标百分比应该是一个小数,并且最大值应该<=1,比如0.5表示50%。

如果position_to_adjust 计算之后是正的,那么会买入该证券,否则会卖出该证券。 需要注意,如果资金不足,该API将不会创建发送订单。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • percent (float) – 仓位最终所占投资组合总价值的目标百分比。

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#如果投资组合中已经有了平安银行股票的仓位,并且占据目前投资组合的10%的价值,那么以下代码会消耗相当于当前投资组合价值5%的现金买入平安银行股票:
order_target_percent('000001.XSHE', 0.15)
返回类型

Optional[Order]

order_target_portfolio - 批量调仓「股票专用」

rqalpha.api.order_target_portfolio(target_portfolio)[源代码]

买入/卖出证券以批量调整证券的仓位,以期使其持仓市值占账户总权益的比重达到指定值。

参数

target_portfolio (Dict[Union[str, Instrument], float]) – 下单标的物及其目标市值占比的字典

Example

# 调整仓位,以使平安银行和万科 A 的持仓占比分别达到 10% 和 15%
order_target_portfolio({
    '000001.XSHE': 0.1
    '000002.XSHE': 0.15
})
返回类型

List[Order]

buy_open - 买开「期货专用」

rqalpha.api.buy_open(id_or_ins, amount, price=None, style=None)[源代码]

买入开仓。

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (int) – 下单手数

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

Example

#以价格为3500的限价单开仓买入2张上期所AG1607合约:
buy_open('AG1607', amount=2, price=3500))
返回类型

Union[Order, List[Order], None]

sell_close - 平买仓「期货专用」

rqalpha.api.sell_close(id_or_ins, amount, price=None, style=None, close_today=False)[源代码]

平买仓

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (float) – 下单手数

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

  • close_today (Optional[bool]) – 是否指定发平今仓单,默认为False,发送平仓单

返回类型

Union[Order, List[Order], None]

sell_open - 卖开「期货专用」

rqalpha.api.sell_open(id_or_ins, amount, price=None, style=None)[源代码]

卖出开仓

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (int) – 下单手数

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

返回类型

Union[Order, List[Order], None]

buy_close - 平卖仓「期货专用」

rqalpha.api.buy_close(id_or_ins, amount, price=None, style=None, close_today=False)[源代码]

平卖仓

参数
  • id_or_ins (Union[str, Instrument]) – 下单标的物

  • amount (int) – 下单手数

  • price (Optional[float]) – 下单价格,默认为None,表示 MarketOrder, 此参数主要用于简化 style 参数。

  • style (Optional[OrderStyle]) – 下单类型, 默认是市价单。目前支持的订单类型有 LimitOrderMarketOrder

  • close_today (Optional[bool]) – 是否指定发平今仓单,默认为False,发送平仓单

Example

#市价单将现有IF1603空仓买入平仓2张:
buy_close('IF1603', 2)
返回类型

Union[Order, List[Order], None]

cancel_order - 撤单

rqalpha.api.cancel_order(order)[源代码]

撤单

参数

order (Order) – 需要撤销的order对象

返回类型

Order

get_open_orders - 获取未成交订单数据

rqalpha.api.get_open_orders()[源代码]

获取当日未成交订单数据

返回类型

List[Order]

exercise - 行权

rqalpha.api.exercise(id_or_ins, amount, convert=False)[源代码]

行权。针对期权、可转债等含权合约,行使合约权利方被赋予的权利。

参数
  • id_or_ins (Union[str, Instrument]) – 行权合约,order_book_id 或 Instrument 对象

  • amount (int) – 参与行权的合约数量

  • convert (Optional[bool]) – 是否为转股(转债行权时可用)

Example

# 行使一张豆粕1905购2350的权力
exercise("M1905C2350", 1)
返回类型

Optional[Order]

持仓查询接口

get_position - 获取持仓对象

rqalpha.api.get_position(order_book_id, direction=POSITION_DIRECTION.LONG)[源代码]

获取某个标的的持仓对象,

参数
  • order_book_id (str) – 标的编号

  • direction (Optional[POSITION_DIRECTION]) – 持仓方向

Example

[In] get_position('000014.XSHE','long_positions")
[Out]
[BookingPosition({'order_book_id': '000014.XSHE', 'quantity': 100, 'today_quantity': 100, 'direction': POSITION_DIRECTION.LONG, 'old_quantity': 0, 'trading_pnl': 1.0, 'avg_price': 9.56, 'last_price': 0, 'position_pnl': 0.0})]
返回类型

Position

get_positions - 获取全部持仓对象

rqalpha.api.get_positions()[源代码]

获取所有持仓对象列表,

Example

[In] get_positions()
[Out]
[BookingPosition({'order_book_id': '000014.XSHE', 'quantity': 100, 'today_quantity': 100, 'direction': POSITION_DIRECTION.LONG, 'old_quantity': 0, 'trading_pnl': 1.0, 'avg_price': 9.56, 'last_price': 0, 'position_pnl': 0.0}),
 BookingPosition({'order_book_id': '000010.XSHE', 'quantity': 100, 'today_quantity': 100, 'direction': POSITION_DIRECTION.LONG, 'old_quantity': 0, 'trading_pnl': 0.0, 'avg_price': 3.09, 'last_price': 0, 'position_pnl': 0.0})]
返回类型

List[Position]

数据查询接口

all_instruments - 所有合约基础信息

rqalpha.api.all_instruments(type=None, date=None)[源代码]

获取某个国家市场的所有合约信息。使用者可以通过这一方法很快地对合约信息有一个快速了解,目前仅支持中国市场。

参数
  • type (Optional[str]) – 需要查询合约类型,例如:type=’CS’代表股票。默认是所有类型

  • date (Union[str, date, None]) – 查询时间点

其中type参数传入的合约类型和对应的解释如下:

合约类型

说明

CS

Common Stock, 即股票

ETF

Exchange Traded Fund, 即交易所交易基金

LOF

Listed Open-Ended Fund,即上市型开放式基金

FenjiMu

Fenji Mu Fund, 即分级母基金

FenjiA

Fenji A Fund, 即分级A类基金

FenjiB

Fenji B Funds, 即分级B类基金

INDX

Index, 即指数

Future

Futures,即期货,包含股指、国债和商品期货

Example

获取中国市场所有分级基金的基础信息:

1
2
3
4
5
6
7
8
9
[In]all_instruments('FenjiA')
[Out]
    abbrev_symbol    order_book_id    product    sector_code  symbol
0    CYGA    150303.XSHE    null    null    华安创业板50A
1    JY500A    150088.XSHE    null    null    金鹰500A
2    TD500A    150053.XSHE    null    null    泰达稳健
3    HS500A    150110.XSHE    null    null    华商500A
4    QSAJ    150235.XSHE    null    null    鹏华证券A
...
返回类型

DataFrame

instruments - 合约详细信息

rqalpha.api.instruments(id_or_symbols)[源代码]

获取某个国家市场内一个或多个合约的详细信息。目前仅支持中国市场。

参数

id_or_symbols (Union[str, List[str]]) – 合约代码或者合约代码列表

Example

  • 获取单一股票合约的详细信息:

    1
    2
    3
    [In]instruments('000001.XSHE')
    [Out]
    Instrument(order_book_id=000001.XSHE, symbol=平安银行, abbrev_symbol=PAYH, listed_date=19910403, de_listed_date=null, board_type=MainBoard, sector_code_name=金融, sector_code=Financials, round_lot=100, exchange=XSHE, special_type=Normal, status=Active)
    
  • 获取多个股票合约的详细信息:

    1
    2
    3
    [In]instruments(['000001.XSHE', '000024.XSHE'])
    [Out]
    [Instrument(order_book_id=000001.XSHE, symbol=平安银行, abbrev_symbol=PAYH, listed_date=19910403, de_listed_date=null, board_type=MainBoard, sector_code_name=金融, sector_code=Financials, round_lot=100, exchange=XSHE, special_type=Normal, status=Active), Instrument(order_book_id=000024.XSHE, symbol=招商地产, abbrev_symbol=ZSDC, listed_date=19930607, de_listed_date=null, board_type=MainBoard, sector_code_name=金融, sector_code=Financials, round_lot=100, exchange=XSHE, special_type=Normal, status=Active)]
    
  • 获取合约已上市天数:

    1
    instruments('000001.XSHE').days_from_listed()
    
  • 获取合约距离到期天数:

    1
    instruments('IF1701').days_to_expire()
    
返回类型

Union[Instrument, List[Instrument]]

history_bars - 某一合约历史 bar 数据

rqalpha.api.history_bars(order_book_id, bar_count, frequency, fields=None, skip_suspended=True, include_now=False, adjust_type='pre')[源代码]

获取指定合约的历史 k 线行情,同时支持日以及分钟历史数据。不能在init中调用。

日回测获取分钟历史数据:不支持

日回测获取日历史数据

调用时间

返回数据

T日before_trading

T-1日day bar

T日handle_bar

T日day bar

分钟回测获取日历史数据

调用时间

返回数据

T日before_trading

T-1日day bar

T日handle_bar

T-1日day bar

分钟回测获取分钟历史数据

调用时间

返回数据

T日before_trading

T-1日最后一个minute bar

T日handle_bar

T日当前minute bar

参数
  • order_book_id (str) – 合约代码

  • bar_count (int) – 获取的历史数据数量,必填项

  • frequency (str) – 获取数据什么样的频率进行。‘1d’或‘1m’分别表示每日和每分钟,必填项

  • fields (Optional[str]) – 返回数据字段。必填项。见下方列表。

  • skip_suspended (Optional[bool]) – 是否跳过停牌数据

  • include_now (Optional[bool]) – 是否包含当前数据

  • adjust_type (Optional[str]) – 复权类型,默认为前复权 pre;可选 pre, none, post

fields

字段名

datetime

时间戳

open

开盘价

high

最高价

low

最低价

close

收盘价

volume

成交量

total_turnover

成交额

open_interest

持仓量(期货专用)

basis_spread

期现差(股指期货专用)

settlement

结算价(期货日线专用)

prev_settlement

结算价(期货日线专用)

Example

获取最近5天的日线收盘价序列(策略当前日期为20160706):

1
2
3
4
[In]
logger.info(history_bars('000002.XSHE', 5, '1d', 'close'))
[Out]
[ 8.69  8.7   8.71  8.81  8.81]
返回类型

ndarray

current_snapshot - 当前快照数据

rqalpha.api.current_snapshot(order_book_id)[源代码]

获得当前市场快照数据。只能在日内交易阶段调用,获取当日调用时点的市场快照数据。 市场快照数据记录了每日从开盘到当前的数据信息,可以理解为一个动态的day bar数据。 在目前分钟回测中,快照数据为当日所有分钟线累积而成,一般情况下,最后一个分钟线获取到的快照数据应当与当日的日线行情保持一致。 需要注意,在实盘模拟中,该函数返回的是调用当时的市场快照情况,所以在同一个handle_bar中不同时点调用可能返回的数据不同。 如果当日截止到调用时候对应股票没有任何成交,那么snapshot中的close, high, low, last几个价格水平都将以0表示。

参数

d_or_symbol – 合约代码或简称

Example

在handle_bar中调用该函数,假设策略当前时间是20160104 09:33:

1
2
3
4
5
[In]
logger.info(current_snapshot('000001.XSHE'))
[Out]
2016-01-04 09:33:00.00  INFO
Snapshot(order_book_id: '000001.XSHE', datetime: datetime.datetime(2016, 1, 4, 9, 33), open: 10.0, high: 10.025, low: 9.9667, last: 9.9917, volume: 2050320, total_turnover: 20485195, prev_close: 9.99)
返回类型

Optional[TickObject]

get_trading_dates - 交易日列表

rqalpha.api.get_trading_dates(start_date, end_date)[源代码]

获取某个国家市场的交易日列表(起止日期加入判断)。目前仅支持中国市场。

参数
  • start_date (Union[str, date]) – 开始日期

  • end_date (Union[str, date]) – 结束如期

返回类型

DatetimeIndex

get_previous_trading_date - 上一交易日

rqalpha.api.get_previous_trading_date(date)[源代码]

获取指定日期的之前的第 n 个交易日。

参数
  • date (Union[str, date]) – 指定日期

  • n (Optional[int]) –

Example

1
2
3
[In]get_previous_trading_date(date='2016-05-02')
[Out]
[datetime.date(2016, 4, 29)]
返回类型

date

get_next_trading_date - 下一交易日

rqalpha.api.get_next_trading_date(date)[源代码]

获取指定日期之后的第 n 个交易日

参数
  • date (Union[str, date]) – 指定日期

  • n (Optional[int]) –

Example

1
2
3
[In]get_next_trading_date(date='2016-05-01')
[Out]
[datetime.date(2016, 5, 3)]
返回类型

date

history_ticks - 指定合约的历史 tick 数据

rqalpha.api.history_ticks(order_book_id, count)[源代码]

获取指定合约历史 tick 对象,仅支持在 tick 级别的策略(回测、模拟交易、实盘)中调用

参数
  • order_book_id (str) – 合约代码

  • count (int) – 获取的 tick 数量

返回类型

List[TickObject]

get_yield_curve - 收益率曲线

rqalpha.api.get_yield_curve(date=None, tenor=None)[源代码]

获取某个国家市场指定日期的收益率曲线水平。

数据为2002年至今的中债国债收益率曲线,来源于中央国债登记结算有限责任公司。

参数
  • date (Union[str, date, None]) – 查询日期,默认为策略当前日期前一天

  • tenor (Optional[str]) – 标准期限,‘0S’ - 隔夜,‘1M’ - 1个月,‘1Y’ - 1年,默认为全部期限

Example

1
2
3
4
5
6
7
8
[In]
get_yield_curve('20130104')

[Out]
                0S      1M      2M      3M      6M      9M      1Y      2Y          2013-01-04  0.0196  0.0253  0.0288  0.0279  0.0280  0.0283  0.0292  0.0310

                3Y      4Y   ...        6Y      7Y      8Y      9Y     10Y          2013-01-04  0.0314  0.0318   ...    0.0342  0.0350  0.0353  0.0357  0.0361
...
返回类型

DataFrame

industry - 行业股票列表

rqalpha.api.industry(code)[源代码]

获得属于某一行业的所有股票列表。

参数

code (str) – 行业名称或行业代码。例如,农业可填写industry_code.A01 或 ‘A01’

我们目前使用的行业分类来自于中国国家统计局的 国民经济行业分类 ,可以使用这里的任何一个行业代码来调用行业的股票列表:

行业代码

行业名称

A01

农业

A02

林业

A03

畜牧业

A04

渔业

A05

农、林、牧、渔服务业

B06

煤炭开采和洗选业

B07

石油和天然气开采业

B08

黑色金属矿采选业

B09

有色金属矿采选业

B10

非金属矿采选业

B11

开采辅助活动

B12

其他采矿业

C13

农副食品加工业

C14

食品制造业

C15

酒、饮料和精制茶制造业

C16

烟草制品业

C17

纺织业

C18

纺织服装、服饰业

C19

皮革、毛皮、羽毛及其制品和制鞋业

C20

木材加工及木、竹、藤、棕、草制品业

C21

家具制造业

C22

造纸及纸制品业

C23

印刷和记录媒介复制业

C24

文教、工美、体育和娱乐用品制造业

C25

石油加工、炼焦及核燃料加工业

C26

化学原料及化学制品制造业

C27

医药制造业

C28

化学纤维制造业

C29

橡胶和塑料制品业

C30

非金属矿物制品业

C31

黑色金属冶炼及压延加工业

C32

有色金属冶炼和压延加工业

C33

金属制品业

C34

通用设备制造业

C35

专用设备制造业

C36

汽车制造业

C37

铁路、船舶、航空航天和其它运输设备制造业

C38

电气机械及器材制造业

C39

计算机、通信和其他电子设备制造业

C40

仪器仪表制造业

C41

其他制造业

C42

废弃资源综合利用业

C43

金属制品、机械和设备修理业

D44

电力、热力生产和供应业

D45

燃气生产和供应业

D46

水的生产和供应业

E47

房屋建筑业

E48

土木工程建筑业

E49

建筑安装业

E50

建筑装饰和其他建筑业

F51

批发业

F52

零售业

G53

铁路运输业

G54

道路运输业

G55

水上运输业

G56

航空运输业

G57

管道运输业

G58

装卸搬运和运输代理业

G59

仓储业

G60

邮政业

H61

住宿业

H62

餐饮业

I63

电信、广播电视和卫星传输服务

I64

互联网和相关服务

I65

软件和信息技术服务业

J66

货币金融服务

J67

资本市场服务

J68

保险业

J69

其他金融业

K70

房地产业

L71

租赁业

L72

商务服务业

M73

研究和试验发展

M74

专业技术服务业

M75

科技推广和应用服务业

N76

水利管理业

N77

生态保护和环境治理业

N78

公共设施管理业

O79

居民服务业

O80

机动车、电子产品和日用产品修理业

O81

其他服务业

P82

教育

Q83

卫生

Q84

社会工作

R85

新闻和出版业

R86

广播、电视、电影和影视录音制作业

R87

文化艺术业

R88

体育

R89

娱乐业

S90

综合

Example

1
2
3
4
5
def init(context):
    stock_list = industry('A01')
    logger.info("农业股票列表:" + str(stock_list))

#INITINFO 农业股票列表:['600354.XSHG', '601118.XSHG', '002772.XSHE', '600371.XSHG', '600313.XSHG', '600672.XSHG', '600359.XSHG', '300143.XSHE', '002041.XSHE', '600762.XSHG', '600540.XSHG', '300189.XSHE', '600108.XSHG', '300087.XSHE', '600598.XSHG', '000998.XSHE', '600506.XSHG']
返回类型

List[str]

sector - 板块股票列表

rqalpha.api.sector(code)[源代码]

获得属于某一板块的所有股票列表。

参数

code (str) – 板块名称或板块代码。例如,能源板块可填写’Energy’、’能源’或sector_code.Energy

目前支持的板块分类如下,其取值参考自MSCI发布的全球行业标准分类:

板块代码

中文板块名称

英文板块名称

Energy

能源

energy

Materials

原材料

materials

ConsumerDiscretionary

非必需消费品

consumer discretionary

ConsumerStaples

必需消费品

consumer staples

HealthCare

医疗保健

health care

Financials

金融

financials

InformationTechnology

信息技术

information technology

TelecommunicationServices

电信服务

telecommunication services

Utilities

公共服务

utilities

Industrials

工业

industrials

Example

1
2
3
4
5
6
7
8
def init(context):
    ids1 = sector("consumer discretionary")
    ids2 = sector("非必需消费品")
    ids3 = sector("ConsumerDiscretionary")
    assert ids1 == ids2 and ids1 == ids3
    logger.info(ids1)
#INIT INFO
#['002045.XSHE', '603099.XSHG', '002486.XSHE', '002536.XSHE', '300100.XSHE', '600633.XSHG', '002291.XSHE', ..., '600233.XSHG']
返回类型

List[str]

get_dividend - 获取分红数据

rqalpha.api.get_dividend(order_book_id, start_date)[源代码]

获取某只股票到策略当前日期前一天的分红情况(包含起止日期)。

参数
  • order_book_id (str) – 股票代码

  • start_date (Union[str, date]) – 开始日期,需要早于策略当前日期

fields

字段名

announcement_date

分红宣布日

book_closure_date

股权登记日

dividend_cash_before_tax

税前分红

ex_dividend_date

除权除息日

payable_date

分红到帐日

round_lot

分红最小单位

Example

获取平安银行2013-01-04 到策略当前日期前一天的分红数据:

1
2
3
4
5
6
7
get_dividend('000001.XSHE', start_date='20130104')
#[Out]
#array([(20130614, 20130619, 20130620, 20130620,  1.7 , 10),
#       (20140606, 20140611, 20140612, 20140612,  1.6 , 10),
#       (20150407, 20150410, 20150413, 20150413,  1.74, 10),
#       (20160608, 20160615, 20160616, 20160616,  1.53, 10)],
#      dtype=[('announcement_date', '<u4'), ('book_closure_date', '<u4'), ('ex_dividend_date', '<u4'), ('payable_date', '<u4'), ('dividend_cash_before_tax', '<f8'), ('round_lot', '<u4')])
返回类型

Optional[ndarray]

is_suspended - 全天停牌判断

rqalpha.api.is_suspended(order_book_id)[源代码]

判断某只股票是否全天停牌。

参数
  • order_book_id (str) – 某只股票的代码或股票代码,可传入单只股票的order_book_id, symbol

  • count (Optional[int]) – 回溯获取的数据个数。默认为当前能够获取到的最近的数据

返回类型

Union[bool, DataFrame]

is_st_stock - ST股判断

rqalpha.api.is_st_stock(order_book_id)[源代码]

判断股票在一段时间内是否为ST股(包括ST与*ST)。

ST股是有退市风险因此风险比较大的股票,很多时候您也会希望判断自己使用的股票是否是’ST’股来避开这些风险大的股票。另外,我们目前的策略比赛也禁止了使用’ST’股。

参数
  • order_book_id (str) – 某只股票的代码,可传入单只股票的order_book_id, symbol

  • count (Optional[int]) – 回溯获取的数据个数。默认为当前能够获取到的最近的数据

返回类型

Union[bool, DataFrame]

get_future_contracts - 期货可交易合约列表

rqalpha.api.get_future_contracts(underlying_symbol)[源代码]

获取某一期货品种在策略当前日期的可交易合约order_book_id列表。按照到期月份,下标从小到大排列,返回列表中第一个合约对应的就是该品种的近月合约。

参数

underlying_symbol (str) – 期货合约品种,例如沪深300股指期货为’IF’

Example

获取某一天的主力合约代码(策略当前日期是20161201):

[In]
logger.info(get_future_contracts('IF'))
[Out]
['IF1612', 'IF1701', 'IF1703', 'IF1706']
返回类型

List[str]

其他接口

update_universe - 更新合约池

rqalpha.api.update_universe(id_or_symbols)[源代码]

该方法用于更新现在关注的证券的集合(e.g.:股票池)。PS:会在下一个bar事件触发时候产生(新的关注的股票池更新)效果。并且update_universe会是覆盖(overwrite)的操作而不是在已有的股票池的基础上进行增量添加。比如已有的股票池为[‘000001.XSHE’, ‘000024.XSHE’]然后调用了update_universe([‘000030.XSHE’])之后,股票池就会变成000030.XSHE一个股票了,随后的数据更新也只会跟踪000030.XSHE这一个股票了。

参数

id_or_symbols (Union[str, Instrument, Iterable[str], Iterable[Instrument]]) – 标的物

返回类型

None

subscribe - 订阅合约

rqalpha.api.subscribe(id_or_symbols)[源代码]

订阅合约行情。该操作会导致合约池内合约的增加,从而影响handle_bar中处理bar数据的数量。

需要注意,用户在初次编写策略时候需要首先订阅合约行情,否则handle_bar不会被触发。

参数

id_or_symbols (Union[str, Instrument, Iterable[str], Iterable[Instrument]]) – 标的物

返回类型

None

unsubscribe - 取消订阅合约

rqalpha.api.unsubscribe(id_or_symbols)[源代码]

取消订阅合约行情。取消订阅会导致合约池内合约的减少,如果当前合约池中没有任何合约,则策略直接退出。

参数

id_or_symbols (Union[str, Instrument, Iterable[str], Iterable[Instrument]]) – 标的物

返回类型

None

subscribe_event - 订阅事件

rqalpha.api.subscribe_event(event_type, handler)[源代码]

订阅框架内部事件,注册事件处理函数

参数
  • event_type (EVENT) – 事件类型

  • handler (Callable[[StrategyContext, Event], None]) – 处理函数

返回类型

None

plot - 画图

rqalpha.api.plot(series_name, value)[源代码]

在生成的图标结果中,某一个根线上增加一个点。

参数
  • series_name (str) – 序列名称

  • value (float) – 值

返回类型

None

scheduler定时器

scheduler.run_daily - 每天运行

scheduler.run_daily(function)

每日运行一次指定的函数,只能在init内使用。

注意,schedule一定在其对应时间点的handle_bar之后执行。

参数

function (func) – 使传入的function每日运行。注意,function函数一定要包含(并且只能包含)context, bar_dict两个输入参数

Example

以下的范例代码片段是一个非常简单的例子,在每天交易后查询现在portfolio中剩下的cash的情况:

1
2
3
4
5
6
7
8
#scheduler调用的函数需要包括context, bar_dict两个输入参数
def log_cash(context, bar_dict):
    logger.info("Remaning cash: %r" % context.portfolio.cash)

def init(context):
    #...
    # 每天运行一次
    scheduler.run_daily(log_cash)

scheduler.run_weekly - 每周运行

scheduler.run_weekly(function, weekday=x, tradingday=t)

每周运行一次指定的函数,只能在init内使用。

注意:

  • tradingday中的负数表示倒数。

  • tradingday表示交易日。如某周只有四个交易日,则此周的tradingday=4与tradingday=-1表示同一天。

  • weekday和tradingday不能同时使用。

参数
  • function (func) – 使传入的function每日交易开始前运行。注意,function函数一定要包含(并且只能包含)context, bar_dict两个输入参数。

  • weekday (int) – 1~5 分别代表周一至周五,用户必须指定

  • tradingday (int) – 范围为[-5,1],[1,5] 例如,1代表每周第一个交易日,-1代表每周倒数第一个交易日,用户可以不填写。

Example

以下的代码片段非常简单,在每周二固定运行打印一下现在的portfolio剩余的资金:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#scheduler调用的函数需要包括context, bar_dict两个参数
def log_cash(context, bar_dict):
    logger.info("Remaning cash: %r" % context.portfolio.cash)

def init(context):
    #...
    # 每周二打印一下剩余资金:
    scheduler.run_weekly(log_cash, weekday=2)
    # 每周第二个交易日打印剩余资金:
    #scheduler.run_weekly(log_cash, tradingday=2)

scheduler.run_monthly - 每月运行

scheduler.run_monthly(function, tradingday=t)

每月运行一次指定的函数,只能在init内使用。

注意:

  • tradingday的负数表示倒数。

  • tradingday表示交易日,如某月只有三个交易日,则此月的tradingday=3与tradingday=-1表示同一。

参数
  • function (func) – 使传入的function每日交易开始前运行。注意,function函数一定要包含(并且只能包含)context, bar_dict两个输入参数。

  • tradingday (int) – 范围为[-23,1], [1,23] ,例如,1代表每月第一个交易日,-1代表每月倒数第一个交易日,用户必须指定。

Example

以下的代码片段非常简单的展示了每个月第一个交易日的时候我们进行一次财务数据查询,这对根据财务数据来调节股票组合的策略会非常有用:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#scheduler调用的函数需要包括context, bar_dict两个参数
def query_fundamental(context, bar_dict):
        # 查询revenue前十名的公司的股票并且他们的pe_ratio在25和30之间。打fundamentals的时候会有auto-complete方便写查询代码。
    fundamental_df = get_fundamentals(
        query(
            fundamentals.income_statement.revenue, fundamentals.eod_derivative_indicator.pe_ratio
        ).filter(
            fundamentals.eod_derivative_indicator.pe_ratio > 25
        ).filter(
            fundamentals.eod_derivative_indicator.pe_ratio < 30
        ).order_by(
            fundamentals.income_statement.revenue.desc()
        ).limit(
            10
        )
    )

    # 将查询结果dataframe的fundamental_df存放在context里面以备后面只需:
    context.fundamental_df = fundamental_df

    # 实时打印日志看下查询结果,会有我们精心处理的数据表格显示:
    logger.info(context.fundamental_df)
    update_universe(context.fundamental_df.columns.values)

 # 在这个方法中编写任何的初始化逻辑。context对象将会在你的算法策略的任何方法之间做传递。
def init(context):
    # 每月的第一个交易日查询以下财务数据,以确保可以拿到最新更新的财务数据信息用来调整仓位
    scheduler.run_monthly(query_fundamental, tradingday=1)

time_rule - 定时间运行

scheduler还可以用来做定时间运行,比如在每天开盘后的一小时后或一分钟后定时运行,这里有很多种组合可以让您达到各种自己想要达到的定时运行的目的。

使用的方法是和上面的 scheduler.run_daily() , scheduler.run_weekly()scheduler.run_monthly() 进行组合加入time_rule来一起使用。

注意:

  • market_open与market_close都跟随中国A股交易时间进行设置,即09:31~15:00。

  • 使用time_rule定时运行只会在分钟级别回测和实时模拟交易中有定义的效果,在日回测中只会默认依然在该天运行,并不能在固定的时间运行。

  • 在分钟回测中如未指定time_rule,则默认在开盘后一分钟运行,即09:31分。

  • 如果两个schedule,分别使用market_open 与market_close规则,但规则触发时间在同一时刻,则market_open的handle一定在market_close的handle前执行。

  • 目前暂不支持开盘交易(即 09:30分交易) ,所以time_rule(minute=0) 和time_rule(hour=0) 将不会触发任何事件。

  • market_open(minute=120)将在11:30执行, market_open(minute=121)在13:01执行,中午休市的区间会被忽略。

  • time_rule=’before_trading’表示在开市交易前运行scheduler函数。该函数运行时间将在before_trading函数运行完毕之后handle_bar运行之前。

time_rule: 定时具体几点几分运行某个函数。time_rule=’before_trading’ 表示开始交易前运行;market_open(hour=x, minute=y)表示A股市场开市后x小时y分钟运行,market_close(hour=x, minute=y)表示A股市场收市前x小时y分钟运行。如果不设置time_rule默认的值是中国A股市场开市后一分钟运行。

market_open, market_close参数如下:

参数

类型

注释

hour

int - option [1,4]

具体在market_open/market_close后/前第多少小时执行, 股票的交易时间为[9:31 - 11:30],[13:01 - 15:00]共240分钟,所以hour的范围为 [1,4]

minute

int - option [1,240]

具体在market_open/market_close的后/前第多少分钟执行,同上,股票每天交易时间240分钟,所以minute的范围为 [1,240],中午休市的时间区间会被忽略。

example

  • 每天的开市后10分钟运行:

    1
    scheduler.run_daily(function, time_rule=market_open(minute=10))
    
  • 每周的第t个交易日闭市前1小时运行:

    1
    scheduler.run_weekly(function, tradingday=t, time_rule=market_close(hour=1))
    
  • 每月的第t个交易日开市后1小时运行:

    1
    scheduler.run_monthly(function, tradingday=t, time_rule=market_open(hour=1))
    
  • 每天开始交易前运行:

    1
    scheduler.run_daily(function, time_rule='before_trading')
    

Context - 策略上下文

class rqalpha.core.strategy_context.StrategyContext[源代码]

策略上下文

property future_account

期货账户

返回类型

Account

property now

当前 Bar/Tick 所对应的时间

返回类型

datetime

property portfolio

策略投资组合,可通过该对象获取当前策略账户、持仓等信息

返回类型

Portfolio

property run_info

测略运行信息

返回类型

RunInfo

property stock_account

股票账户

返回类型

Account

property universe

在运行 update_universe(), subscribe() 或者 unsubscribe() 的时候,合约池会被更新。

需要注意,合约池内合约的交易时间(包含股票的策略默认会在股票交易时段触发)是handle_bar被触发的依据。

返回类型

Set[str]

RunInfo - 策略运行信息

class rqalpha.core.strategy_context.RunInfo(config)[源代码]

策略运行信息

property commission_multiplier

手续费倍率

返回类型

float

property end_date

策略的结束日期

返回类型

date

property frequency

‘1d’或‘1m’

返回类型

str

property future_starting_cash

期货账户初始资金

返回类型

float

property margin_multiplier

保证金倍率

返回类型

float

property matching_type

撮合方式

返回类型

str

property run_type

运行类型

返回类型

str

property slippage

滑点水平

返回类型

float

property start_date

策略的开始日期

返回类型

date

property stock_starting_cash

股票账户初始资金

返回类型

float

Bar - k 线行情

class rqalpha.model.bar.BarObject(instrument, data, dt=None)[源代码]

基类:object

property close

[float] 收盘价

property datetime

[datetime.datetime] 时间戳

property high

[float] 最高价

property is_trading

[bool] 是否有成交量

property last

[float] 当前最新价

property limit_down

[float] 跌停价

property limit_up

[float] 涨停价

property low

[float] 最低价

property open

[float] 开盘价

property open_interest

[float] 截止到当前的持仓量(期货专用)

property order_book_id

[str] 交易标的代码

property prev_close

[float] 昨日收盘价

property prev_settlement

[float] 昨日结算价(期货专用)

property settlement

[float] 结算价(期货专用)

property symbol

[str] 合约简称

property total_turnover

[float] 截止到当前的成交额

property volume

[float] 截止到当前的成交量

Tick - 快照行情

class rqalpha.model.tick.TickObject(instrument, tick_dict)[源代码]

基类:object

property ask_vols

[list] 卖出报盘数量,ask_vols[0]代表盘口卖一档报盘数量

property asks

[list] 卖出报盘价格,asks[0]代表盘口卖一档报盘价

property bid_vols

[list] 买入报盘数量,bids_vols[0]代表盘口买一档报盘数量

property bids

[list] 买入报盘价格,bids[0]代表盘口买一档报盘价

property datetime

[datetime.datetime] 当前快照数据的时间戳

property high

[float] 截止到当前的最高价

property last

[float] 当前最新价

property limit_down

[float] 跌停价

property limit_up

[float] 涨停价

property low

[float] 截止到当前的最低价

property open

[float] 当日开盘价

property open_interest

[float] 截止到当前的持仓量(期货专用)

property order_book_id

[str] 标的代码

property prev_close

[float] 昨日收盘价

property prev_settlement

[float] 昨日结算价(期货专用)

property total_turnover

[float] 截止到当前的成交额

property volume

[float] 截止到当前的成交量

Order - 订单

class rqalpha.model.order.Order[源代码]

基类:object

property avg_price

[float] 成交均价

property datetime

[datetime.datetime] 订单创建时间

property filled_quantity

[int] 订单已成交数量

property frozen_price

[float] 冻结价格

property message

[str] 信息。比如拒单时候此处会提示拒单原因

property order_book_id

[str] 合约代码

property order_id

[int] 唯一标识订单的id

property position_effect

[POSITION_EFFECT] 订单开平(期货专用)

property price

[float] 订单价格,只有在订单类型为’限价单’的时候才有意义

property quantity

[int] 订单数量

property secondary_order_id

[str] 实盘交易中交易所产生的订单ID

property side

[SIDE] 订单方向

property status

[ORDER_STATUS] 订单状态

property trading_datetime

[datetime.datetime] 订单的交易日期(对应期货夜盘)

property transaction_cost

[float] 费用

property type

[ORDER_TYPE] 订单类型

property unfilled_quantity

[int] 订单未成交数量

Portfolio - 投资组合

class rqalpha.portfolio.Portfolio(starting_cash, init_positions)[源代码]

基类:object

投资组合,策略所有账户的集合

property accounts

账户字典

返回类型

Dict[DEFAULT_ACCOUNT_TYPE, Account]

property annualized_returns

[float] 累计年化收益率

property cash

[float] 可用资金

property daily_pnl

[float] 当日盈亏

property daily_returns

[float] 当前最新一天的日收益

property frozen_cash

[float] 冻结资金

property future_account

[FutureAccount] 期货账户

property market_value

[float] 市值

property pnl

[float] 收益

property portfolio_value

[Deprecated] 总权益

property positions

[dict] 持仓字典

property start_date

[datetime.datetime] 策略投资组合的开始日期

property starting_cash

[float] 初始资金

property static_unit_net_value

[float] 昨日净值

property stock_account

[StockAccount] 股票账户

property total_returns

[float] 累计收益率

property total_value

[float]总权益

property transaction_cost

[float] 交易成本(税费)

property unit_net_value

[float] 实时净值

property units

[float] 份额

Account - 账户

class rqalpha.portfolio.account.Account(type, total_cash, init_positions)[源代码]

账户,多种持仓和现金的集合。

不同品种的合约持仓可能归属于不同的账户,如股票、转债、场内基金、ETF 期权归属于股票账户,期货、期货期权归属于期货账户

property buy_margin

多方向保证金

返回类型

float

calc_close_today_amount(order_book_id, trade_amount, position_direction)[源代码]

根据计算当前不超过 trade_amount 的最大可平仓量

property cash

可用资金

返回类型

float

property daily_pnl

当日盈亏

返回类型

float

property equity

总权益

返回类型

float

property frozen_cash

冻结资金

返回类型

float

get_position(order_book_id, direction)[源代码]

获取某个标的的持仓对象

参数
返回类型

Position

get_positions()[源代码]

获取所有持仓对象列表,

返回类型

Iterable[Position]

get_state()[源代码]

主要用于进行持久化时候,提供对应需要持久化的数据

property margin

总保证金

返回类型

float

property market_value

[float] 市值

返回类型

float

property position_pnl

昨仓盈亏

返回类型

float

property sell_margin

空方向保证金

返回类型

float

set_state(state)[源代码]

主要用于持久化恢复时,根据提供的持久化数据进行恢复Account的实现

property total_cash

账户总资金

返回类型

float

property total_value

账户总权益

返回类型

float

property trading_pnl

交易盈亏

返回类型

float

property transaction_cost

总费用

返回类型

float

Position - 持仓

class rqalpha.portfolio.position.Position(order_book_id, direction, init_quantity=0)[源代码]
property closable

可平仓位

返回类型

int

property direction

返回当前持仓的方向

返回类型

POSITION_DIRECTION

property margin

返回当前持仓所占的保证金

返回类型

float

property market_value

返回当前持仓的市值

返回类型

float

property order_book_id

返回当前持仓的 order_book_id

返回类型

str

property pnl

返回该持仓的累积盈亏

返回类型

float

property position_pnl

返回当前持仓当日的持仓盈亏

返回类型

float

property quantity

返回当前持仓量

返回类型

int

property today_closable

返回今仓中的可平仓位

返回类型

int

property trading_pnl

返回当前持仓当日的交易盈亏

返回类型

float

Instrument - 交易标的

class rqalpha.model.instrument.Instrument[源代码]
order_book_id

【str】股票:证券代码,证券的独特的标识符。应以’.XSHG’或’.XSHE’结尾,前者代表上证,后者代表深证。期货:期货代码,期货的独特的标识符(郑商所期货合约数字部分进行了补齐。例如原有代码’ZC609’补齐之后变为’ZC1609’)。主力连续合约UnderlyingSymbol+88,例如’IF88’ ;指数连续合约命名规则为UnderlyingSymbol+99

symbol

【str】股票:证券的简称,例如’平安银行’。期货:期货的简称,例如’沪深1005’。

abbrev_symbol

【str】证券的名称缩写,在中国A股就是股票的拼音缩写,例如:’PAYH’就是平安银行股票的证券名缩写;在期货市场中例如’HS1005’,主力连续合约与指数连续合约都为’null’。

round_lot

【int】股票:一手对应多少股,中国A股一手是100股。期货:一律为1。

sector_code(股票专用)

【str】板块缩写代码,全球通用标准定义

sector_code_name(股票专用)

【str】以当地语言为标准的板块代码名

industry_code(股票专用)

【str】国民经济行业分类代码,具体可参考下方“Industry列表”

industry_name(股票专用)

【str】国民经济行业分类名称

listed_date

【str】股票:该证券上市日期。期货:期货的上市日期,主力连续合约与指数连续合约都为‘0000-00-00’。

de_listed_date

【str】股票:退市日期。期货:交割日期。

type

【str】合约类型,目前支持的类型有: ‘CS’, ‘INDX’, ‘LOF’, ‘ETF’, ‘FenjiMu’, ‘FenjiA’, ‘FenjiB’, ‘Future’

concept_names(股票专用)

【str】概念股分类,例如:’铁路基建’,’基金重仓’等

exchange

【str】交易所。股票:’XSHE’ - 深交所, ‘XSHG’ - 上交所。期货:’DCE’ - 大连商品交易所, ‘SHFE’ - 上海期货交易所,’CFFEX’ - 中国金融期货交易所, ‘CZCE’- 郑州商品交易所

board_type(股票专用)

【str】板块类别,’MainBoard’ - 主板,’GEM’ - 创业板

status(股票专用)

【str】合约状态。’Active’ - 正常上市, ‘Delisted’ - 终止上市, ‘TemporarySuspended’ - 暂停上市, ‘PreIPO’ - 发行配售期间, ‘FailIPO’ - 发行失败

special_type(股票专用)

【str】特别处理状态。’Normal’ - 正常上市, ‘ST’ - ST处理, ‘StarST’ - *ST代表该股票正在接受退市警告, ‘PT’ - 代表该股票连续3年收入为负,将被暂停交易, ‘Other’ - 其他

contract_multiplier(期货专用)

【float】合约乘数,例如沪深300股指期货的乘数为300.0

underlying_order_book_id(期货专用)

【str】合约标的代码,目前除股指期货(IH, IF, IC)之外的期货合约,这一字段全部为’null’

underlying_symbol(期货专用)

【str】合约标的名称,例如IF1005的合约标的名称为’IF’

maturity_date(期货专用)

【str】期货到期日。主力连续合约与指数连续合约都为‘0000-00-00’

settlement_method(期货专用)

【str】交割方式,’CashSettlementRequired’ - 现金交割, ‘PhysicalSettlementRequired’ - 实物交割

product(期货专用)

【str】产品类型,’Index’ - 股指期货, ‘Commodity’ - 商品期货, ‘Government’ - 国债期货

Instrument对象也支持如下方法:

合约已上市天数:

instruments(order_book_id).days_from_listed()

如果合约首次上市交易,天数为0;如果合约尚未上市或已经退市,则天数值为-1

合约距离到期天数:

instruments(order_book_id).days_to_expire()

如果策略已经退市,则天数值为-1

最小价格变动单位:

instruments(order_book_id).tick_size()

枚举常量

POSITION_DIRECTION - 持仓方向

class rqalpha.const.POSITION_DIRECTION[源代码]
LONG

多方向

SHORT

空方向

SIDE - 交易方向

class rqalpha.const.SIDE[源代码]
BUY

SELL

POSITION_EFFECT - 交易动作

class rqalpha.const.POSITION_EFFECT[源代码]
OPEN

开仓

CLOSE

平仓

CLOSE_TODAY

平今

EXERCISE

行权

MATCH

轧差

RIGHT_TYPE - 权利类型

class rqalpha.const.RIGHT_TYPE
CONVERT

转股

SELL_BACK

回售

ORDER_TYPE - 订单类型

class rqalpha.const.ORDER_TYPE[源代码]
MARKET

市价单

LIMIT

限价单

ORDER_STATUS - 订单状态

class rqalpha.const.ORDER_STATUS[源代码]
PENDING_NEW

待报

ACTIVE

已报

FILLED

全成

CANCELLED

已撤

REJECTED

拒单

RUN_TYPE - 策略运行类型

class rqalpha.const.RUN_TYPE[源代码]
BACKTEST

回测

PAPER_TRADING

实盘模拟

EVENT - 事件类型

class rqalpha.events.EVENT[源代码]
ORDER_PENDING_NEW

订单创建成功

ORDER_CREATION_PASS

订单已报

ORDER_CREATION_REJECT

订单创建被拒

ORDER_PENDING_CANCEL

订单待撤

ORDER_CANCELLATION_PASS

订单撤单成功

ORDER_CANCELLATION_REJECT

订单撤单被拒

ORDER_UNSOLICITED_UPDATE

订单已报被拒

TRADE

成交