python_API

基本方法

编写策略过程中所需要使用的基本函数。其中init和handle_bar是必须实现的两个方法,其余是可选择实现的方法。

init (必须实现)

init(context)

初始化方法--你的算法会使用这个方法来设置你需要的各种初始化配置。context 对象将会在你的算法的所有其他的方法之间进行传递以方便你可以拿取到。
详情参考：

1. "backtest"回测 和 "paper_trading"实际交易模式中 在回测和实时交易只会在启动的时候触发一次。
   
2. "pel_call"被PEL公式调用时,在公式被初次加载时被触发一次。

参数

范例

def init(context):
# cash_limit的属性是根据用户需求自己定义的,你可以定义无限多种自己随后需要的属性
    context.cash_limit = 5000

handle_bar (必须实现)

函数原型

handle_bar(context)

bar数据的更新会自动触发该方 法的调用。策略具体逻辑可在该方法内实现,在实时交易中,该函数在交易时间内会根据选择运行模式被触发。

参数

范例

def handle_bar(context):
# 市价开多100手/股。自己构建开仓条件
    buy_open("SZ000001", "Market",0 ,100)

before_trading (选择实现)

函数原型

before_trading(context)

每天在基准合约开盘前30分钟会被调用。不能在这个函数中发送订单。

参数

范例

def before_trading (context):
    #获取平安银行EPS财务字段数据
    dataval = fin_indicator('SZ000001','EPS',1,0,0)
    #将查询到的财务数据保存到context对象中
    context.eps = dataval

after_trading (选择实现)

函数原型

after_trading(context)

每天在基准合约收盘后5分钟被调用。不能在这个函数中发送订单。您可以在该函数中进行当日收盘后的一些计算。(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式)

参数

order_status(选择实现)

函数原型

order_status(context,order)

当委托下单,成交,撤单等与下单有关的动作时,该方法就会被调用。(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式)

参数

范例

def order_status(context,order):
    #判断柜台回报信息,是否为全部成交。
    if order.status=='filled':
        print('全部成交')

order_action (选择实现)

函数原型

order_action(context,type, account, datas)

当查询交易接口信息时返回的通知。

参数

exit(选择实现)

函数原型

exit(context)

用户可以在该函数中处理一些退出后需要做的事情,比如记录一些变量到硬盘等。

1. "backtest"回测模式下,当测评结束时,该函数被调用。
   
2. "paper_trading"实际交易模式下,停止策略运行时,该函数被调用。
   
3. "pel_call"被PEL公式调用时,在PEL公式关闭时调用。

参数

parameter (选择实现)

函数原型

parameter()

参数定义区,这里定义的参数可以直接在context对象中获取。--(选择实现)

1. 参数定义区定义的变量,可以用于策略运行中动态调整参数
2. 必须使用input_par函数,定义变量,并且此函数仅支持在parameter()方法内使用。
3. parameter 方法仅对"backtest"回测 和 "paper_trading"模式有效。

参数

无

范例

def parameter():
    # 使用input_par函数定义变量"myvalues1",默认值5,最小值1,最大值100,步长1。
    input_par("myvalues1",5,1,20,1)
    # 使用input_par函数定义变量"myvalues2",默认值10,最小值1,最大值100,步长1。
    input_par("myvalues2",10,1,20,1)
        .
        .
        .
def handle_bar(context):
    print(context.myvalues1+context.myvalues2)

模式说明

Python策略分为三类：Python策略、Python引用、Python模块
Python策略：Python运行策略
Python引用：编写可用于PEL调用Python模块
Python模块：供Python调用的用户模块或供VBA调用的模块。

上述3类受python运行模式限制,具体区别见下表：

交易函数

buy_open 开多（买开）

函数原型

buy_open(order_book_id,style,price,volume,amount,hedge_flag,order_queue,slithermethod,account,repeat,serial_id)

参数

返回值

​int类型的order_id,即订单id ,当返回-1表示下单失败,失败原因需要翻阅日志记录。
当order_queue或slithermethod为True时,无法返回实际order_id,返回值恒定为0,失败返回 None。

范例

#市价委托方式,买入平安银行1000股
buy_open("SZ000001", "Market",0 ,1000)
#使用账号'12345'以市价方式买入2手螺纹钢。
buy_open("SQRB00", "Market",0 ,2,account='12345')

sell_close 平多（卖平）

函数原型

sell_close (order_book_id,style,price,volume,amount,hedge_flag,order_queue,slithermethod,account,repeat,serial_id)

参数

返回值

​int类型的order_id,即订单id ,当返回-1表示下单失败,失败原因需要翻阅日志记录。
当order_queue或slithermethod为True时,无法返回实际order_id,返回值恒定为0,失败返回 None。

范例

#限价3600元,将当前账户的RBOO品种的20手仓位平掉。（平多）
sell_close("SQRB00", "Limit",3600 ,20)

sell_open 开空（卖开/融券开仓）

函数原型

sell_open (order_book_id,style,price,volume,amount,hedge_flag,order_queue,slithermethod,account,repeat,serial_id)

参数

返回值

​int类型的order_id,即订单id ,当返回-1表示下单失败,失败原因需要翻阅日志记录。
当order_queue或slithermethod为True时,无法返回实际order_id,返回值恒定为0,失败返回 None。

范例

#开空
sell_open ("SQRB00", "Limit",3600 ,20)

buy_close 平空(买平/买券还券)

函数原型

buy_close (order_book_id,style,price,volume,amount,hedge_flag,order_queue,slithermethod,account,repeat,serial_id)

参数

返回值

​ int类型的order_id,即订单id ,当返回-1表示下单失败,失败原因需要翻阅日志记录。
当order_queue或slithermethod为True时,无法返回实际order_id,返回值恒定为0,失败返回 None。

范例

#平空
buy_close ("SQRB00", "Limit",3600 ,20)

get_orders 获取当日委托订单

函数原型

get_orders (order_book_id, type, account) 

获取当日委托订单。其数据来自账户栏的“委托记录”中的记录。

参数

返回值

​ list of Order对象

范例

示例1：
#获取当日平安银行所有委托单的价格
id_list = get_orders("SZ000001", 1)
if not(id_list == None):
    for i in id_list:
        write_logging(str(i.price))

示例2：
#获取所有平安银行的未成交订单order对象
a = get_orders("SZ000001", 0)

get_orders_id 获取当日指定id的委托订单

函数原型

get_orders_id (order_id,account)

获取当日指定id的委托订单 。

参数

返回值

​ Order对象,失败返回 None

范例

#获取当日订单Id列表
id_list=get_orders("SQRB00", 1, '5')
#得到上一次委托订单的order对象属性。并输出成交状态。
if not(id_list == None):
    id_last=get_orders_id (id_list[-1].order_id)
    write_logging(id_last.status)

cancel_order 撤销指定order_id的订单

函数原型

cancel_order (order_id,queue,account)

撤销指定order_id的订单 。(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式)

参数

返回值

​ 无,失败返回 None

范例

#获取最近一个订单状态。
id_list=get_orders("SQRB00", 1, '5')
if not(id_list == None):
    id_last=get_orders_id (id_list[-1].order_id)
#如果最近一次订单状态为未成交,则进行撤单操作。
    if  id_last.status =='submitted':
        cancel_order (id_last.order_id)

get_traders 获取当日成交订单

函数原型

get_traders (order_book_id, account)

获取当日成交订单

参数

返回值

​ list of trader对象,失败返回 None

范例

#获得平安银行当日第一笔成交单的类型
a = get_traders("SZ000001")
if not(a==None):
    print(a[0].type)

get_account 得到投资者账户信息

函数原型

get_account (type,account) 

得到投资者账户信息。

参数

返回值

​ 返回相应账户信息数值,失败返回None

范例

#获取账号'60032182'当前的浮动盈利
get_account(4,'60032182')

get_account_book 得到当前登录所有账户列表

函数原型

get_account_book() 

得到当前登录所有账户列表,（注意也包括连接失败的）

参数

​ 无

返回值

​ list of str 账户列表

范例

#获得登录的资金账号列表
account=get_account_book()

isaccount 判断指定帐号是否是当前已登录有效帐号

函数原型

isaccount(account)

判断指定帐号是否是当前已登录有效帐号,例如 isaccount("351579"),如果该账户已登录则返回True,否则返回False

参数

返回值

​ bool 账户已登录则返回True,否则返回False

范例

get_portfolio 投资组合信息

函数原型

get_portfolio (order_book_id, type, account,calc) 

投资组合信息(股票+期货的混合)。

参数

返回值

​ portfolio对象,失败返回 None

范例

#获得"RB10"品种的浮动盈亏,（多空同时存在时,为多空浮动盈亏之和）
portfolio=get_portfolio ("SQRB10", 2)
write_logging(str(portfolio.pnl))

get_portfolio_book 投资组合持仓品种

函数原型

get_portfolio_book (type, account) 

投资组合持仓品种

参数

返回值

​ 返回 list of str,若没有任何持仓,则返回一个空的list

范例

#得到账户'5'当前的持仓品种列表。
portfolio=get_portfolio_book  (2, "5")
#判断该账户中是否已经持有指定的品种。如果有则输出'已经持仓',否者输出'未持仓'或者进行其他相应的操作处理。
if 'SQRB00' in portfolio:
    write_logging('已持仓')
else:
    write_logging('未持仓')

模组函数

模组函数只能在paper_trading 模式下使用。其他模式下无效。

get_group_count 得到当前已设置模组的数量

函数原型 get_group_count()

得到当前已设置模组的数量

参数

无

返回值

​ 失败返回NONE

范例

#得到模组账户的数量。
count=get_group_count()
print(count)

get_group_index 取指定序号的模组ID

函数原型

get_group_index(index)

取指定序号的模组ID 取得基于0开始序号的模组ID

参数

返回值

​ 成功返回str类型的模组ID,失败返回NONE

范例

#得到模组账户的数量。
count=get_group_count()
#遍历得到模组ID集合
for i in range(count):
    GID=get_group_index(i)
    print("模组ID " + GID)

get_group_avg_price 得到指定模组ID下指定品种的持仓均价

函数原型

get_group_avg_price(groupid,order_book_id,type)

得到指定模组ID下指定品种的持仓均价

参数

返回值

​ 返回float类型,失败返回NONE

范例

#得到模组账户ID集合中的第二个模组账户的id。
GID=get_group_index(1)
#获取"JGROUP0002"模组账户中燃油合约的持仓均价
avg_price=get_group_avg_price(GID,"SQFU00",2)
print(avg_price)

get_group_info 得到指定模组ID的模组运行信息

函数原型

get_group_info(type,groupid)

得到指定模组ID的模组运行信息

参数

返回值

   type=1返回str类型
   type=2返回int类型
   type=3返回int类型
   type=4返回float类型
   type=5返回float类型
   type=6返回float类型
   type=7返回str类型
,   失败时返回NONE

范例

#得到模组账户ID集合中的第二个模组账户的id。
GID=get_group_index(1)
#获取"JGROUP0002"模组账户的浮动盈亏
Order_Profit=get_group_avg_price(4,GID)
print(Order_Profit)

get_group_hold_count 得到指定模组ID下的持仓品种数量

函数原型

get_group_hold_count(groupid)

得到指定模组ID下的持仓品种数量 注：

参数

返回值

返回int类型,失败返回NONE

范例

#得到模组账户ID集合中的第二个模组账户的id。
GID=get_group_index(1)
#获取模组"JGROUP0002"账户下持仓品种的数量
group_hold_count=get_group_hold_count(GID)
print(group_hold_count)

get_group_hold_index 得到指定模组ID下的指定序号的持仓品种代码

函数原型

get_group_hold_index(index,groupid)

得到指定模组ID下的指定序号的持仓品种代码

参数

返回值

返回str类型,失败返回NONE

范例

#得到模组账户ID集合中的第二个模组账户的id。
GID=get_group_index(1)
#获取模组"JGROUP0002"账户下第2条持仓记录对应的品种代码
group_hold_name=get_group_hold_index(1,GID)
print(group_hold_name)

get_group_holding 得到指定模组ID下指定品种持仓量

函数原型

get_group_holding(groupid, order_book_id, type1, type2)

得到指定模组ID下指定品种持仓量

参数

返回值

返回int类型,失败返回NONE

范例

#获取模组"JGROUP0002"账户下燃油的多头今仓数量
day_holding=get_group_holding("JGROUP0002","SQFU00",0,2)
print(day_holding)

#获取模组"JGROUP0002"账户下燃油的多头持仓总数量
all_holding=get_group_holding("JGROUP0002","SQFU00",0,2)
print(all_holding)

数据查询函数

history_bars 某一合约历史数据

函数原型

history_bars(order_book_id, bar_count,frequency,fields,skip_suspended, include_now,adjusted_price)

参数

返回值

​ ndarray ,方便直接与talib等计算库对接, 失败返回 空列表。

注意：返回值使用前应该判断数组长度和是否为空列表或者低于指定长度,以免运行出错。

范例

#获取最近10天的日线收盘价序列
bar_len=10
bar_close=history_bars('SQRB00',bar_len,'1d','CLOSE')
#对返回值k线数量进行检查
if len(bar_close)<bar_len:
    print('获取数据不足,请补充数据!!!')
else:
    print(bar_close)

history_bars_date 某一合约指定时段内的历史数据

函数原型

history_bars_date(order_book_id, start_date,end_date, frequency,fields, skip_suspended, include_now,adjusted_price)

参数

返回值

​ ndarray ,方便直接与talib等计算库对接, 失败返回 空列表。

注意：返回值使用前应该判断数组长度和是否为空列表或者低于指定长度,以免运行出错。

范例

#获取20180901至20180910区间的日线收盘价序列
bar_close=history_bars_date('SQRB00','20180901','20180910','1d','close')
#对返回值k线数量进行检查
print(bar_close)

pel_history_bars 获取历史数据（python引用）

函数原型

pel_history_bars("bar_count", "fields") 

python引用方式下获取历史数据,仅"pel_call"模式有效参数

参数

返回值

​ ndarray ,方便直接与talib等计算库对接, 失败返回 空列表。

注意：返回值使用前应该判断数组长度和是否为空列表或者低于指定长度,以免运行出错。

范例

#调取收盘价数据,long_period的值为通过pel的SETPYTHONVAL函数设置
close = pel_history_bars(context.long_period+1 , 'close')

#计算均线,返回值放在context对象中。
context.ma10 = close[-context.long_period:].sum() / context.long_period

get_dynainf 当前快照数据

函数原型

get_dynainf (order_book_id,type)

当前快照数据,只有最新值,无历史数据。(不支持回测)

参数

返回值

​ datetime.date ,若失败返回 None

范例

#获取rb00当前最新价
get_dynainf('SQRB00',7)

is_data_update 判断数据是否更新

函数原型

is_data_update (order_book_id)

判断这次调用该品种距离上次调用是否有过数据更新,可以使用该函数对停牌或交易不活跃品种进行过滤,防止调用history_bars取数据时的计算重复。

参数

返回值

int类型。

范例

#判断'ag06'合约数据是否更新。
data = history_bars('sh600000',1,'self','CLOSE')
if is_data_update ('sh600000')==1:
    write_logging（'数据更新'）

istradertime 判断品种当前是否在交易时间时段内

函数原型

istradertime(order_book_id)

判断指定品种当前是否在交易时间时段中 注意：请确保您的计算机时间处于正确时间中,因为某些时候需要借助本地时间做参考。

参数

返回值

bool True表示当前处于可交易时间中

范例

get_previous_trading_date 基准合约上一交易日

函数原型

get_previous_trading_date (date,n)

获取基准合约指定日期的上一（或n）交易日

参数

返回值

​ datetime.date ,若失败返回 None

范例

#获取2018-07-29的前5个交易日所在的日期
get_previous_trading_date ('2018-07-29',5)

get_next_trading_date 基准合约下一交易日

函数原型

get_next_trading_date (date,n) 

获取基准合约指定日期的下一（或n）交易日

参数

返回值

​ datetime.date ,若失败返回 None

get_trading_dates 基准合约的交易日列表

函数原型

get_trading_dates (start_date,end_date) 

获取基准合约的交易日列表（起止日期加入判断）(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式),该函数计算量较大,请注意编写效率,不要再循环中使用。

参数

返回值

​ datetime.date list,若失败返回 None

范例

#获取'2018-07-20'至'2018-07-30'期间的交易日期的集合
get_trading_dates ('2018-07-20','2018-07-30') 

get_split 当期除权数据

函数原型

get_split (order_book_id,count)

获取指定品种到策略当前日期的（除权）拆分情况

参数

返回值

​ list of split对象 , 若失败返回 None

范例

#获取平安银行最近2次除权数据信息,其返回值为list of split对象
get_split ('sz000001',2)

get_price_change_rate 指定品种的历史涨跌幅

函数原型

get_price_change_rate (order_book_id,count)

获取指定品种的历史涨跌幅(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式),该函数计算量较大,请注意编写效率,不要再循环中使用。

参数

返回值

​ list of dataval对象 , 若失败返回 None

范例

#获取平安银行最近10日的涨跌幅
get_price_change_rate('sz000001',10)

get_blocks 获取指定板块的成份股列表

函数原型

get_blocks (block_name,type)

获取指定板块的成份股列表

参数

注：
市场分类：来源于在k线图右键“更换品种”--“市场”中展示的分类。例如：上海期货、深圳A股等
分类板块: 来源于在菜单栏“工具”--“市场与板块”--“板块”中展示的板块,如：地域中的”北京、上海“,自选中的"自选股"等。
系统分类：来源于在菜单栏“工具”--“市场与板块”--“品种”中展示的分类。如“中金所”,“国内商品”

返回值

​ list of str (order_book_id list) , 若失败返回 None

范例

#获取'自选股'分类版块中的品种代码,
get_blocks ('自选股',1)

get_inblocks 获取指定品种的所属板块

函数原型

get_inblocks(book_id) 获取指定品种的所属板块

参数

返回值

​ list of str , 若失败返回空列表

范例

#获取'sz000001'品种所属的板块,
get_inblocks ('sz000001')

update_blocks 更新板块中的品种

函数原型

update_blocks (order_book_id,block_name)

更新指定板块品种,该函数触发时,会将之前板块的品种清除后再添加新品种至板块中。

参数

返回值

​ 无

范例

#将'600000'股票更新至自选股板块。
update_blocks ('SH600000','自选股')

append_blocks添加指定板块中的品种

函数原型

append_blocks (order_book_id,block_name)

将指定品种以“追加方式”添加到指定版块中。

参数

返回值

​ 无

范例

#追加品种至指定'自选股'板块中。
append_blocks ('SH600007','自选股')

remove_blocks 删除指定板块中的品种

函数原型

remove_blocks(order_book_id,block_name)

删除指定板块中的品种

参数

返回值

​ 无

范例

#删除'自选股'板块中'SH600007'股票品种。
remove_blocks ('SH600007','自选股')

get_turnover_rate 历史换手率

函数原型

get_turnover_rate (order_book_id,count,stat)

获取历史换手率

参数

返回值

​ list of dataval对象 , 若失败返回 None

范例

#获取5日线历史换手率。
get_turnover_rate('SH600000',10,5)

get_instruments查询合约基础信息

函数原型

get_instruments (order_book_id)

查询合约基础信息

参数

返回值

instruments对象, 若失败返回 None

范例

#获取RB00品种的合约基本信息
instruments=get_instruments ('SQRB00')
#输出RB00合约的合约单位
print(instruments.multipliter)

get_charge计算交易费用

函数原型

get_charge (order_book_id,price,volume,type)

计算交易费用,根据 交易菜单->合约信息设置 中预设的合约信息和费率

参数

返回值

交易费用

范例

#计算1手多头螺纹钢所需手续费费用
get_charge ('SQRB00',get_dynainf('SQRB00',7),1,0)

财务函数

get_finance 基础财务数据

函数原型

get_finance (order_book_id,type,count,filter,offset)

获取基础财务数据。包含常用的50+个财务字段,能满足基本使用需求。详细字段参考pel函数说明或者查阅“附表”章节。

参数

返回值

list of dataval对象 , 若失败返回 空列表

范例

#获取最近一期‘平安银行的'每股净资
bar_len=10
get_fin=get_finance('SZ000001',34,bar_len,0,0)
if len(get_fin)<bar_len:
    print("财务数据获取不足,请补充下载")
else:
    print(get_fin[-1].values)

fin_balance_std 一般工商业资产负债表

函数原型

fin_balance_std (order_book_id,items,count,filter,offset)

获取一般行业资产负债数据. 注：该表包含所有A股品种资产负债数据,包括银行、证券、保险类字段。可理解为合并财务报表。若使用需要获取金融类的特有字段,可以直接查询金融类专用财务报表（银行、证券、保险）。

参数

返回值

list

范例

示例1：
#获取'归属于母公司所有者权益合计'财务字段。
TEquityAttrP = fin_balance_std('SZ000001','TEquityAttrP',10,0,0)
#判断获取数据长度是否足够。
if len(TEquityAttrP)<10:
    print("财务数据获取不足,请补充下载")
else:
    print(TEquityAttrP)

示例2：
#多维度财务获取。
#获得'600007'和'600008'品种的'归属于母公司所有者权益合计'和'所有者权益合计'财务字段
df=fin_balance_std(['sh600007','SH600008'],['TEquityAttrP','TShEquity'],1,0,0)

fin_balance_zq 证券业资产负债表

函数原型

fin_balance_zq (order_book_id,items,count,filter,offset)

获取披露的证券行业资产负债数据。

参数

返回值

list

fin_balance_bx保险业资产负债表

函数原型

fin_balance_bx (order_book_id,items,count,filter,offset)

获取保险行业披露的资产负债数据。

参数

返回值

list

fin_balance_yh 银行业资产负债表

函数原型

fin_balance_yh (order_book_id,items,count,filter,offset)

获取银行业披露的资产负债数据。

参数

返回值

list

fin_profit_std 一般工商业利润分配表

函数原型

fin_profit_std (order_book_id,items,count,filter,offset)

一般工商业利润分配表 注：该表包含所有A股品种资产负债数据,包括银行、证券、保险类字段。可理解为合并财务报表。若使用需要获取金融类的特有字段,可以直接查询金融类专用财务报表（银行、证券、保险）。

参数

返回值

list

范例

#获取'营业总收入'财务字段数据
tRevenue = fin_profit_std('SH600007','tRevenue',1,0,0)

fin_profit_zq 证券业资产利润分配表

函数原型

fin_profit_zq (order_book_id,items,count,filter,offset)

证券业利润分配表

参数

返回值

list

fin_profit_bx 保险业利润分配表

函数原型

fin_profit_bx (order_book_id,items,count,filter,offset)

保险业利润分配表

参数

返回值

list

fin_profit_yh 银行业利润分配表

函数原型

fin_profit_yh (order_book_id,items,count,filter,offset)

银行业利润分配表

参数

返回值

list

fin_cashflow_std 一般工商业现金流量表

函数原型

fin_cashflow_std (order_book_id,items,count,filter,offset)

一般工商业现金流量表

参数

返回值

list

范例

#获取'经营活动现金流出小计'财务字段。
COutfOperateA = fin_cashflow_std('SH600007','COutfOperateA',1,0,0)

fin_cashflow_zq 证券行业现金流量表

函数原型

fin_cashflow_zq (order_book_id,items,count,filter,offset)

证券行业现金流量表

参数

返回值

list

fin_cashflow_bx 保险业现金流量表

函数原型

fin_cashflow_bx (order_book_id,items,count,filter,offset)

保险业现金流量表

参数

返回值

list

fin_cashflow_yh 银行业现金流量表

函数原型

fin_cashflow_yh (order_book_id,items,count,filter,offset)

银行业现金流量表

参数

返回值

list

fin_indicator衍生数据表

函数原型

fin_indicator (order_book_id,items,count,filter,offset)

财务衍生数据字段。

参数

返回值

list

范例

#获取衍生数据'每股收益'的财务数据
EPS = fin_indicator('SH600007','EPS',1,0,0)

fin_com_holder 持股股东数

函数原型

fin_com_holder (order_book_id,items,count,filter,offset)

持股股东户数

参数

返回值

list

范例

#得到'SH600007'品种的持股股东户数
shNum = fin_com_holder('SH600007','shNum',1,0,0)

fin_com_share 股本结构表

函数原型

fin_com_share (order_book_id,items,count,offset）

股本结构表。

参数

返回值

list

范例

#获取总股本
totalShares = fin_com_share('SH600007','totalShares',1,0)

fin_com_swhy2014 申万行业分类

函数原型

fin_com_swhy2014 (order_book_id,items)

申万行业分类,该表只提供最新的品种分类信息数据。

参数

返回值

数据项对应值

范例

#获取该品种的三级分类名称
industryName = fin_com_swhy2014('SH600007','industryName3')

fin_stock_information 公司IPO信息表

函数原型

fin_stock_information (order_book_id,items)

公司IPO信息表,公司上市时的信息。

参数

返回值

数据项对应值

范例

#上市日期
listDate = fin_stock_information('SH600007','listDate')

fin_holder_top10 公司十大股东

函数原型

fin_holder_top10 (order_book_id,items, sort,count,filter,offset)

参数

返回值

list

范例

#获得排名第二的股东名称
holder_top = fin_holder_top10('SH600007','shName',2,1,0,0)

fin_tradableshare_top10 公司十大流通股东

函数原型

fin_tradableshare_top10 (order_book_id,items, sort,count,filter,offset)

参数

返回值

list

fin_limited_list 股改限售解禁明细

函数原型

fin_limited_list (order_book_id,items,count,offset)

股改限售解禁明细

参数

返回值

list

期权统计函数

get_option_info 得到期权最新的特征值

函数原型

get_option_info(order_book_id,type)

得到期权最新的特征值（仅对期权品种有效）.
注意：该函数仅返回最新值,无历史值。部分计算参数在 在分析菜单->期权定价计算 中设置。

参数

返回值

计算的当前最新值结果

范例

#判断该品种期权方向,0-认购期权,1-认沽期权
get_option_info('10001211',4)

option_strike 期权行权委托

函数原型

option_strike(order_book_id,volume,account)

期权行权委托

参数

返回值

​ int order_id 订单id ,当返回-1表示下单失败,失败原因需要翻阅日志记录,失败返回 None

cancelstrike 行权撤销操作

函数原型

cancelstrike(order_book_id,account)

行权撤销操作

参数

volatility 历史波动率

函数原型

volatility(data,size)

历史波动率

参数

返回值

​ float 波动率结果

impliedvolatility 隐含波动率

函数原型

impliedvolatility(order_book_id,srcprice, volatility, days, nowprice, R)

隐含波动率

参数

返回值

​ float 隐含波动率结果

optiongreekvalue 统计期权合约的特征值

函数原型

optiongreekvalue(order_book_id,srcprice, volatility, days, type, R)

统计期权合约的特征值

参数

返回值

​ float 隐含波动率结果

optionbsprice 用B-S模型计算一个欧式期权的理论价格

函数原型

optionbsprice(order_book_id,srcprice, volatility, days, R)

用B-S模型计算一个欧式期权的理论价格,股票期权和股指期权的计算中都不考虑股息影响.

参数

返回值

​ float 返回计算后的期权理论价格

optionlabel_book 取指定标的指定月份的期权合约

函数原型

optionlabel_book(code,market,month, type)

取指定标的指定月份的期权合约

参数

返回值

​ list of str 返回实际的期权合约

opobyprirce 通过行权价获取相关期权合约

函数原型

opobyprirce(code,market,price, direct, monthtype, check)

通过行权价获取相关期权合约,可以通过该方法函数方便的对标的合约的行权价相关的期权合约进行快速定位

参数

返回值

​ str 查找到的期权合约order_book_id,若没有找到返回空字符串

两融操作函数

synchrosecurities 刷新同步两融账户中的可融券信息

synchrosecurities(account)

请求刷新同步指定或全部登录的两融账户中的可融券信息

注意：请不要频繁调用该函数,以免给服务器造成过大压力。查询完成后的事件通知在order_action中标志为1的事件中获取。

参数

get_securities 得到指定账户的指定基于0索引的融券信息

get_securities(account)

得到指定账户的指定基于0索引的融券信息 使用该函数方法前请务必调用synchrosecurities函数已确保可融券信息已经下载到客户端,可在order_action事件方法中确认是否下载成功

参数

返回值

​ list of securities对象

新股申购函数

reqnewstockinfo 请求查询当日可申购新股信息

reqnewstockinfo(account)

请求查询当日可申购新股信息

参数

注意：
1、查询完成后的事件通知在order_action中标志为2的事件中获取。
2、请不要频繁的重复的调用该函数,一般该函数每个交易日连接交易服务器后只调用一次即可。

get_newstockinfo 得到可申购新股信息

get_newstockinfo(account)

得到可申购新股信息,请务必确认使用前调用reqnewstockinfo函数,并确认收到order_action中标志为2的事件。

参数

返回值

​ list of newstockinfo对象

范例

get_newstockmaxvol 得到指定市场最大可申购数量

get_newstockmaxvol(market,account)

得到指定市场最大可申购数量

参数

返回值

​ int 返回查询到的最大可申购数量,可以使用该返回值做新股申购

reqnewstocklotinfo 新股申购中签查询

reqnewstocklotinfo(startdate,enddate,account)

新股申购中签查询

参数

注意
1、查询完成后的事件通知在order_action中标志为3的事件中获取。
2、查询历史中签记录日期间隔天数不能大于30天。
3、请不要频繁的重复的调用该函数,一般该函数每个交易日连接交易服务器后只调用一次即可。 ​

get_newstocklotinfo 得到新股中签信息

get_newstocklotinfo(account)

得到新股中签信息 注意：调用该函数前,请务必至少调用一次reqnewstocklotinfo函数查询操作。并确认收到order_action中标志为3的事件。

参数

返回值

​ list of newstockinfo对象

buy_newstock 执行新股申购委托操作

buy_newstock(label,market,price,volume,account)

执行新股申购委托操作

参数

返回值

​ int order_id 订单id ,当返回-1表示下单失败,失败原因需要翻阅日志记录,失败返回 None

全局变量函数

全局变量数据库是金字塔内部的一种小型数据库,用来存放用户作用整个金字塔全局的变量。 可以使用全局变量做变量存储,或者与PEL,VBA进行数据交互。

setextdata 以数值方式设置指定名称的全局变量数据

函数原型

setextdata(item,data)

以数值方式设置指定名称的全局变量数据。数据存储在“工具”--“数据管理”--“全局变量”中

参数

注意： 数值型float金字塔采取单精度浮点数存储,如果数值过大可能会丢失精度,此时可以改为字符串存储以保留精度。

返回值

无

范例

#设置TEST全局变量的值。
setextdata('TEST',1)
#打印输出'TEST'的结果     
print(getextdata('TEST'))

getextdata 得到指定名称的全局变量数据

函数原型

getextdata(item)

得到指定名称的全局变量数据,数据存储在“工具”--“数据管理”--“全局变量”中 例如:getextdata("ABC"),函数将返回"ABC"名称的全局变量数据。

参数

返回值

float 或 int

注意： 数值型float金字塔采取单精度浮点数存储,如果数值过大可能会丢失精度,此时可以改为字符串存储以保留精度。

setextstring 以字符串方式设置指定名称的字符串全局变量数据

函数原型

setextstring(item, data)

以字符串方式设置指定名称的字符串全局变量数据

参数

getextstring 得到指定名称的字符串全局变量数据

函数原型

getextstring(item)

得到指定名称的字符串全局变量数据,该函数用法与getextdata函数相同,但此函数将返回字符串,如果键值是数字数据名称,会将该数字转换为字符串输出。

参数

返回值

str

范例

clearextdata 从全局变量数据库中清除所有全局变量数据

函数原型

clearextdata()

从全局变量数据库中清除所有全局变量数据

参数

​ 无

返回值

​ 无

其它函数

settimer 设定计时器—定时触发

函数原型

settimer (funciton, msec)

设定计时器—定时触发,仅"paper_trading"模式有效

参数

返回值

无

范例

import time
def init(context):
    # 设置计时器 
    settimer(msg,10)

def msg(context):
    #输出现在时间
    a = time.asctime( time.localtime(time.time()) )
    print(a)
#退出程序后杀死计时器
def exit(context):
    killtimer(msg)

killtimer 结束计时器

函数原型

killtimer(funciton)

结束计时器,仅"paper_trading"模式有效

参数

返回值

无

范例

import time
def init(context):
    # 设置计时器 
    settimer(msg,10)

def msg(context):
    #输出现在时间
    a = time.asctime( time.localtime(time.time()) )
    print(a)
#退出程序后杀死计时器
def exit(context):
    killtimer(msg)

write_logging 调试打印输出

函数原型

write_logging (msg)

屏幕字符打印输出,该函数可以直接在print函数不能显示的函数外执行,推荐调试时使用

参数

返回值

无

范例

#判断init事件函数在启动时,是否正常运行。
def init(context):

    ...
    #执行完毕省略部分的代码后,输出字符串“策略初始化工作已经完成！”。（省略部分代码请自行填充）
    write_logging ('策略初始化工作已经完成！')

log_debug_info 日志写盘

函数原型

log_debug_info(file_path, text_data)

日志写盘,利用该函数可以将运行中的参数写盘,方便策略编写调试期间查找问题
注：适用于以下三种模式："backtest"模式、"paper_trading"模式和"pel_call"模式下有效。

参数

返回值

无

范例

#使用log_debug_info函数,输出策略执行过程中产生的结果,进行分析。
log_debug_info('D:\debugfile.txt', '输出跟踪测试的内容到debugfile文件中')

update_universe 更新合约池

函数原型

update_universe (order_book_id)

该方法用于更新现在关注的品种的集合（e.gPS：会在下一个bar事件触发时候产生（新的关注的合约池更新）效果。并且update_universe会是覆盖（overwrite）的操作而不是在已有的股票池的基础上进行增量添加。比如已有的股票池为['SZ000001', 'SZ000024']然后调用了update_universe(['SH000030'])之后,股票池就会变成SH000030一个股票了,随后的数据更新也只会跟踪SH000030这一个股票了。
(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式) 参数

返回值

无

范例

#把'sh600000','sh600007'更新到当前合约池中
update_universe (['sh600000','sh600007'])

append_universe添加到合约池

函数原型

append_universe (order_book_id)

添加品种到合约池
(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式) 参数

返回值

无

范例

#把'sh600000','sh600007'追加到当前合约池中
append_universe (['sh600000','sh600007'])

remove_universe 删除合约池

函数原型

remove_universe (order_book_id)

删除合约池中的品种
(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式) 参数

返回值

无

get_indicator获取PEL指标线值

函数原型

get_indicator(order_book_id,name,line,parameter,freq,count,skip_suspended,include_now,adjusted_price)

引用金字塔PEL指标线值的值。
(仅策略交易状态时有效,"backtest"回测 和 "paper_trading"模式),注意该函数占用资源较大,请注意编程效率。

参数

返回值

ndarray 方便直接与talib等计算库对接,失败返回 None

范例

#引用PEL指标公式"my_test"的ma5日均线指标值。PEL指标必须提前存在或者构建。
get_indicator('sh600000','my_test','ma5','30','1d',10)

call_vba 执行VBA函数调用计算

函数原型

call_vba(function,...)

执行VBA函数调用计算

参数

返回值

str 或 float 或 int

范例

# 执行vba中名为 Test_fun_call 函数,参数分别为 1和2。
ret = call_vba("Test_fun_call",1,2)
print(ret)

add_test_report 添加自定义测试报告项函数原型

函数原型

add_test_report (item,itemdata)

添加自定义测试报告项, 该函数仅对测评状态有效,推荐放在 exit 事件函数中使用

参数

返回值

无

input_par 申明参数

函数原型

input_par(PAR_NAME,DFT,MIN,MAX,STEP)

此函数仅支持在parameter()方法内使用,其它方法或者函数内使用无效。声明的变量在使用时,直接从context对象中获取。

参数

范例

#input_par函数必要在parameter方法内实现声明变量。
def parameter():
       #申明变量"myvalues1"和"myvalues2"并初始赋值。
    input_par("myvalues1",20,1,20,1)
    input_par("myvalues2",10,1,20,1)

test_report_none 禁用回测弹出测试报告

函数原型

test_report_none()

此函数一般用于用于exit事件函数内,作用为禁用回测完成后弹出测试报告。

参数

无

范例

# exit事件函数会在测评结束或者停止策略运行时调用test_report_none函数。
def exit(context):
    test_report_none()

重要对象

context对象

run_info对象

order对象

portfolio对象

trader对象

split对象

dataval对象

instruments对象

securities对象

newstockinfo对象

newstocklotinfo对象

附表

type参数 (get_account函数)

type参数 (get_finance函数)

type参数 (get_dynainf函数)

type参数 (get_option_info函数)