get_stock_status - 获取证券状态信息

get_stock_status 是 PTrade 中用于获取证券状态信息的接口。

原型

get_stock_status(stocks, query_type='ST', query_date=None)

释义

get_stock_status 是 PTrade 中用于获取证券状态信息的接口。

研究:支持;回测:支持;模拟:官方目录未明确;实盘:支持。

参数

参数 是否必填 官方原始定义
stocks stocks
query_type query_type='ST'
query_date query_date=None

返回值

返回dict类型,每支证券对应的值为True或False(dict[str:bool,...])。当没有查询到相关数据或者输入有误时返回None(NoneType);

{'600570': None}

示例

def initialize(context):

g.security = ['600397.SS', '600701.SS', '000001.SZ']

set_universe(g.security)

def handle_data(context, data):

stocks_list = g.security

filter_stocks = []

# 判断证券是否为ST、停牌或者退市

st_status = get_stock_status(stocks_list, 'ST')

# 将不是ST的证券筛选出来

for i in stocks_list:

if st_status[i] is not True:

filter_stocks.append(i)

# 获取证券停牌信息

# halt_status = get_stock_status(stocks_list, 'HALT')

# 获取指定日期的对应属性

# halt_status = get_stock_status(stocks_list, 'HALT', '20180312')

# 获取证券退市信息

# delist_status = get_stock_status(stocks_list, 'DELISTING')

log.info('筛选不是ST的证券列表: %s' % filter_stocks)

详细说明

get_stock_status(stocks, query_type='ST', query_date=None)

使用场景

该函数在研究、回测、交易模块可用

接口说明

该接口用于获取指定日期证券的ST、停牌、退市等属性。

注意事项

参数详细说明

stocks: 例如 ['000001.SZ','000003.SZ']。该字段必须输入,否则返回None(list[str]/str);

query_type: 支持以下四种类型属性的查询,默认为'ST'(str);

具体支持输入的字段包括 :

'ST' - 查询是否属于ST证券

'HALT' - 查询是否停牌

'DELISTING' - 查询是否退市

'DELISTING_SORTING' - 查询是否退市整理期(只支持交易场景下查询当日数据,查询历史返回空字典)

query_date: 格式为YYYYmmdd,默认为None,表示当前日期(回测为回测当前周期,研究与交易则取系统当前时间)(str);

返回值

返回dict类型,每支证券对应的值为True或False(dict[str:bool,...])。当没有查询到相关数据或者输入有误时返回None(NoneType);

{'600570': None}