研究环境API文档¶

def query_iwencai(query, domain='股票', timeout=6, df=True):
    """
    从问财官网获取问句选股结果,区别于get_iwencai(用于回测获取历史选股),有一定调用频率限制
    :param query: 自然语句
    :param domain: 可选'股票'、'基金'、'指数'、'新三板'、'港股'、'美股'
    :param timeout: 超时时间
    :param df: 格式化dataframe
    :return: pd.DataFrame, 选股结果
    """

def get_price(securities, start_date=None, end_date='20180101', fre_step='1d', fields=None, skip_paused=False, 
              fq='pre', bar_count=0, is_panel=False):
    """
    获取多只证券多属性历史行情数据
    :param securities:股票, 指数或基金代码列表(单个, 多个, 列表), 如['000001.SZ','600000.SH','510300.OF']
    :param start_date:起始时间，与bar_count二选一，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:36'
    :param end_date:结束时间，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:36'
    :param fre_step:时间步长，'Xd'代表X天, 'Xm'代表X分钟
    :param fields:数据字段，如['open', 'close']，分钟和日级支持以下字段:'open': 开盘价(元)，'high': 最高价(元)，'low': 最低价(元)，'close': 收盘价(元)，'factor': 复权因子(复权因子 = 后复权价格 / 不复权价格)，'volume': 成交量(股)，'turnover': 成交额(元)，'turnover_rate': 换手率(%)，'is_paused': 是否停牌, 返回值为0或1, 0表示未停牌；日级还支持以下字段：'high_limit': 涨停价(元)，'low_limit': 跌停价(元)，'avg_price': 均价(元)，'prev_close': 前收盘价(元)，'quote_rate': 涨跌幅(%)，'amp_rate': 振幅(%)=(最高－最低)/昨收，'is_st': 是否为ST, 返回值为0或1, 0表示非ST
    :param skip_paused:是否跳过停牌数据，若选择跳过，则停牌期间用停牌前的数据填充
    :param fq:复权选项，None-不复权, 'post'-后复权, 'pre'-前复权
    :param bar_count:历史长度
    :param is_panel:is_panel = 1则返回Pandas.Panel格式的数据，is_panel = 0则返回dict格式的数据, key为symbol
    """

def get_candle_stick(securities, end_date='20180101', fre_step='1d', fields=None, skip_paused=False, fq='pre', 
                     bar_count=0, is_panel=False):
    """
    获取多只证券多属性历史行情数据
    :param securities:股票, 指数或基金代码列表(单个, 多个, 列表), 如['000001.SZ','600000.SH','510300.OF']
    :param end_date:结束时间，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:36'
    :param fre_step:时间步长，分钟级: '1m', '5m', '15m', '30m', '60m'; 日级: 'xd'; 周级:'week'; 月级: 'month'; 年级: 'year'
    :param fields:数据字段，支持以下字段:'open': 开盘价(元)，'high': 最高价(元)，'low': 最低价(元)，'close': 收盘价(元)，'volume': 成交量(股)
    :param skip_paused:是否跳过停牌数据，若选择跳过，则停牌期间用停牌前的数据填充
    :param fq:复权选项，None-不复权, 'post'-后复权, 'pre'-前复权
    :param bar_count:历史长度
    :param is_panel:is_panel = 1则返回Pandas.Panel格式的数据，is_panel = 0则返回dict格式的数据, key为symbol
    """

def get_price_future(symbol_list, start_date, end_date, fre_step, fields, bar_count = 0, is_panel = 0):
    """
    获取一只（或多只）期货品种多属性历史行情数据, 回测环境和研究环境均可使用，但要注意在回测时，可能存在未来函数的问题 
    :param symbol_list: 期货合约代码 . 例如:symbol= ['RB1810','RB9999','RB8888']
    :param start_date: 起始时间 . 时间格式: '%Y%m%d %H:%M'；与bar_count二选一；取日级数据时, 传入格式为: '20170105' ；取分钟数据时, 传入格式为: '20170105 14:36'
    :param end_date: 结束时间 . 时间格式: '%Y%m%d %H:%M'；取日级数据时, 传入格式为: '20170105' ；取分钟数据时, 传入格式为: '20170105 14:36'
    :param fre_step: 时间步长 . 其中'Xd'代表X天, 'Xm'代表X分钟, 'Xt'代表Xtick；例如: fre_step = '1d'表示时间步长为1天；当X>1时, fields只支持 'open', 'close', 'high', 'low', 'volume', 'turnover'这几个字段
    :param fields: 数据字段 . 支持以下字段: 'open': 开盘价(元)；　'high': 最高价(元)；　'low': 最低价(元)；　'close': 收盘价(元)；　'high_limit': 涨停价(元)；　'low_limit': 跌停价(元)；　'settle':结算价（元）；　'pre_settle': 前结算价(元)；　'volume': 成交量(双边)；　'turnover': 成交额(元)；　'change': 涨跌（元）；　'quote_rate': 涨跌幅(%) ；　'amp_rate': 振幅(%)；　'open_interest': 持仓；　'pos_change': 仓差
    :param bar_count: 历史长度 . 与start_date 二选一, 例如bar_count = 5, 表示获取过去5 个时间步长的历史数据
    :param is_panel: 返回数据格式  . 默认为dict, 即is_panel = 0； is_panel = 1则返回Pandas.Panel格式的数据, key为fields；is_panel = 0则返回dict格式的数据, key为inst_id
    """

def get_tick(securities,start_date,end_date,fields):
    """
    获取tick数据. 使用范围：研究环境中使用. 
    :param securities: str or list 订阅股票标的物
    :param start_date: str or Date 开始时间
    :param end_date: str or Date 结束时间
    :param fields: 字段列表,支持字段见说明
    """

def get_stats(date):
    """
    获取每日/实时行情中各个涨跌区间的个股数量，回测环境和研究环境均可使用。 列表内各数据代表的涨跌幅区间如下（一共21个涨跌幅区间）：(无穷小,-9)，[-9,-8)，[-8,-7)，[-7,-6)，[-6,-5)，[-5,-4)，[-4,-3)，[-3,-2)，[-2,-1)，[-1,-0)，[0]，(0,1)，[1,2)，[2,3)，[3,4)，[4,5)，[5,6)，[6,7)，[7,8)，[8,9)，[9,无穷大]
    :param date: 日期 . 时间格式: '%Y%m%d' ；取日级数据时, 传入格式为: '20170105'；取实时行情数据时，传入格式为：None
    """

def get_resistance_support(symbol_list, start_date, end_date, fre_step, fields, bar_count=0, is_panel=0):
    """
    获取多只证券股价压力位、支撑位信息
    :param symbol_list:股票, 指数或基金代码列表(单个, 多个, 列表), 如['000001.SZ','600000.SH','510300.OF']
    :param start_date:起始时间，与bar_count二选一，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:36'
    :param end_date:结束时间，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:36'
    :param fre_step:其中'1d'代表1天, '30m'代表30分钟, '5m'代表5分钟, 例如: fre_step = '1d'表示时间步长为1天, 目前只支持以上三种频率步长
    :param fields:支持以下字段: 'resistance_line': 价格压力位(元),'support_line': 价格支撑位(元)
    :param bar_count:历史长度
    :param is_panel:is_panel = 1则返回Pandas.Panel格式的数据, is_panel = 0则返回dict格式的数据, key为symbol
    """

def get_mtss(security_list, start_date=None, end_date='20180101', fields=None, count=None, is_panel=False):
    """
    获取股票的历史融资融券数据
    :param security_list:股票列表(单个, 多个, 列表), 如['000001.SZ','600000.SH']
    :param start_date:起始时间，与count二选一，只支持日级数据时, 传入格式为: '20170105'
    :param end_date:结束时间，只支持日级数据时, 传入格式为: '20170105'
    :param fields:支持以下字段:'fin_value': 融资余额(元), 'fin_buy_value': 融资买入额(元),'fin_refund_value': 融资偿还额(元), 'sec_value': 融券余额(元), 'sec_sell_value': 融券卖出额(元), 'sec_refund_value': 融券偿还额(元), 'fin_sec_value': 融资融券余额(元)
    :param count:历史长度
    :param is_panel:is_panel = 1则返回Pandas.Panel格式的数据, is_panel = 0则返回dict格式的数据, key为symbol
    """

def get_money_flow_step(security_list, start_date=None, end_date='20180101', fre_step='1d', fields=None, count=None,
                        is_panel=False):
    """
    获取历史资金数据，包括1日、30分钟、5分钟
    :param security_list:股票列表(单个, 多个, 列表), 如['000001.SZ','600000.SH']
    :param start_date:起始时间，与count二选一，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:00'
    :param end_date:结束时间，取日级数据时, 传入格式为: '20170105'，取分钟数据时, 传入格式为: '20170105 14:00'
    :param fre_step:时间步长，其中'1d'代表1天， '30m'代表30分钟， '5m'代表5分钟
    :param fields:支持以下字段：'act_buy_xl'：主动买入特大单金额（元），'pas_buy_xl'：被动买入特大单金额（元）,'act_buy_l'：主动买入大单金额（元）,'pas_buy_l'：被动买入大单金额（元）,'act_buy_m'：主动买入中单金额（元）,'pas_buy_m'：被动买入中单金额（元）,'act_sell_xl'：主动卖出特大单金额（元）,'pas_sell_xl'：被动卖出特大单金额（元）,'act_sell_l'：主动卖出大单金额（元）,'pas_sell_l'：被动卖出大单金额（元）,'act_sell_m'：主动卖出中单金额（元）,'pas_sell_m'：被动卖出中单金额（元）,'buy_l'：小单买入金额（元）,'sell_l'：小单卖出金额（元）,'dde_l'：DDE大单净额（元）,'net_flow_rate'：金额流入率（%）,'l_net_value'：大单净量
    :param count:历史长度
    :param is_panel:is_panel = 1则返回Pandas.Panel格式的数据, is_panel = 0则返回dict格式的数据, key为symbol
    """

def get_money_flow(security_list, start_date=None, end_date='20180101', fields=None, count=None, is_panel=False):
    """
    获取资金流数据，只支持日级
    :param security_list:股票列表(单个, 多个, 列表), 如['000001.SZ','600000.SH']
    :param start_date:起始时间，与count二选一，只支持日级数据时, 传入格式为: '20170105'
    :param end_date:结束时间，只支持日级数据时, 传入格式为: '20170105'
    :param fields:支持以下字段：'act_buy_xl'：主动买入特大单金额（元），'pas_buy_xl'：被动买入特大单金额（元）,'act_buy_l'：主动买入大单金额（元）,'pas_buy_l'：被动买入大单金额（元）,'act_buy_m'：主动买入中单金额（元）,'pas_buy_m'：被动买入中单金额（元）,'act_sell_xl'：主动卖出特大单金额（元）,'pas_sell_xl'：被动卖出特大单金额（元）,'act_sell_l'：主动卖出大单金额（元）,'pas_sell_l'：被动卖出大单金额（元）,'act_sell_m'：主动卖出中单金额（元）,'pas_sell_m'：被动卖出中单金额（元）,'buy_l'：小单买入金额（元）,'sell_l'：小单卖出金额（元）,'dde_l'：DDE大单净额（元）,'net_flow_rate'：金额流入率（%）,'l_net_value'：大单净量
    :param count:历史长度
    :param is_panel:is_panel = 1则返回Pandas.Panel格式的数据, is_panel = 0则返回dict格式的数据, key为symbol
    """

def get_security_info(symbol):
    """
    获取单只证券的基本信息
    :param symbol:股票、指数、股指期货或基金代码    
    """

def get_all_securities(ty=None, date=None):
    """
    获取所有证券的基本信息，包括股票、基金、指数
    :param ty:类型,包括：'stock'、'index'、'etf'、'lof'、'fja'、'fjb'、'futures'、'commodity_futures'
    :param date:查询日期,格式：'%Y%m%d',date参数提供默认值.在研究模块和模拟交易模块: 默认是今天的上一个交易日.
    """

def get_fundamentals(query_object, date, statDate):
    """
    查询财务数据
    :param query_object: 所需要查询的财务信息条件 一般格式为:q = query().filter().order_by().limit()；query()内填写需要查询的指标，支持指标见说明；filter()内填写数据筛选条件；order_by()数据排序；limit()数据数量限制
    :param date: 查询指定日期的财务数据 参数输入格式：'%Y%m%d'.例如：'20170808'(必须是交易日),该参数与 statDate参数二选一,只能且必须填写其中一个.
    :param statDate: 查询指定季度或年份的财务数据 该参数与date参数二选一,只能且必须填写其中一个.季报：'年+q+季度序号'，例如：'2015q1'表示2015年一季报;年报：年份的数字，例如：'2015'表示2015年年报
    """

def get_analyst_forecast(query_object):
    """
    获取分析师评级预测相关数据
    :param query_object: 所需要查询的分析师评级预测信息条件，一般格式为:q = q = query().filter()
    """

def get_factors(query_object):
    """
    get_factors函数的主要功能是获取因子数据.例如:技术指标MA,MACD以及部分财务数据. 
    :param query_object: 所需要查询的因子数据条件 一般格式为:q = query().filter().order_by().limit()；query()内填写需要查询的指标；filter()内填写数据筛选条件；order_by()数据排序；limit()数据数量限制
    """

def get_sfactor_data(start_date, end_date, stocks, factor_input):
    """
    get_sfactor_data函数的主要功能是获取因子数据（已做数据处理：去极值、标准化）
    :param start_date: 开始时间 支持字符串格式，例如:'20190318'
    :param end_date: 结束时间 支持字符串格式，例如:'20190318'
    :param stocks: 股票列表 支持列表格式，例如:['300033.SZ','600519.SH']
    :param factor_input: 因子字段 列表格式，例如：['trix']
    """

def get_important_matters(query_object):
    """
    获取非常丰富的特色数据,例如:资产剥离事件、实控人变更事件、节日事件、深港通事件、举牌、违规处罚等等! 
    :param query_object: 所要查询的数据条件
    """

def get_company_basic_information(query_object):
    """
    获取公司基本信息.例如:省份、代码、日期、概念数据. 
    :param query_object: 所要查询的数据条件
    """

def rationed_shares_information(query_object):
    """
    获取个股的配股信息,包括：配股股权登记日、每股配股数. 
    :param query_object: 所要查询的数据条件
    """

def dividend_information(query_object):
    """
    获取个股的分红信息,包括：预案公告日、每股红股、每股转增股本、现金分红比例、派息日、股权登记日、预披露公告日期等数据. 
    :param query_object: 所要查询的数据条件
    """

def get_index_stocks(symbol, date):
    """
    get_index_stocks函数的主要功能是获取指数对应的成分股股票代码. 
    :param symbol: 指数代码 字符串格式的指数代码,例如:'000300.SH'
    :param date: 查询日期 格式：'%Y%m%d'
    """

def get_index_weight(symbol,date):
    """
    get_index_weight函数的主要功能是获取指数成分股权重数据. 
    :param symbol: 指数代码 字符串格式的指数代码
    :param date: 查询日期 格式：'%Y%m%d'
    """

def get_industry_stocks(symbol, date):
    """
    get_industry_stocks函数的主要功能是获取行业对应的成分股股票代码. 
    :param symbol: 行业代码 字符串格式的行业代码,例如:'T0101'
    :param date: 查询日期 格式：'%Y%m%d'
    """

def get_symbol_industry(symbol, date):
    """
    get_symbol_industry函数的主要功能是获取股票所属同花顺行业,包含同花顺行业、申万行业、证监会行业. 
    :param symbol: 股票代码 字符串格式的股票代码,例如:'000001.SZ'.
    :param date: 查询日期 格式：'%Y%m%d'
    """

def get_concept_stocks(symbol, date):
    """
    get_concept_stocks函数的主要功能是获取同花顺概念板块对应的成分股股票代码. 
    :param symbol: 概念代码 字符串格式的概念代码,例如:'300037'(同花顺智能电网概念)
    :param date: 查询日期 格式：'%Y%m%d'
    """

def get_trade_days(start_date, end_date, count=None):
    """
    get_trade_days函数的主要功能获取指定时间段内的交易日. 
    :param start_date: 起始时间 格式：'%Y%m%d'.与count参数二选一,只能且必须填其中一个.
    :param end_date: 结束时间 格式：'%Y%m%d'.必须填写结束日期.
    :param count: 历史长度 填数值,例如count=1,则代表以结束时间为起点向前取一天的历史数据.与start_date参数二选一,只能且必须填其中一个.
    """

def get_all_trade_days():
    """
    get_all_trade_days函数的主要功能获取所有交易日列表. 
    """

def get_extras(security_list, start_date, end_date, fields, count=None):
    """
    get_extras函数的主要功能获取基金的单位净值、累积净值、复权净值数据. 
    :param security_list: 基金代码列表 列表格式,例如:['510300.OF','510500.OF']
    :param start_date: 起始时间 格式：'%Y%m%d'.与count参数二选一,只能且必须填其中一个.
    :param end_date: 结束时间 格式：'%Y%m%d'.必须填写结束日期.
    :param fields: 数据字段 支持以下字段：'unit_net_value'：单位净值(元/份)； 'acc_net_value'：累计净值(元/份)； 'pre_net_value'：复权净值(元/份)
    :param count: 历史长度 填数值,例如count=1,则代表以结束时间为起点向前取一天的历史数据.与start_date参数二选一,只能且必须填其中一个.
    """

def get_hold_detail(query_object):
    """
    get_hold_detail函数用来获取基金持仓数据. 
    :param query_object: 所需要查询的数据条件
    """

def get_futures_info(symbol,date):
    """
    获取期货品种相关信息 
    :param symbol: 品种名称 . 例如：symbol='RB'
    :param date: 获取主力合约的时间 . 时间格式: '%Y%m%d'
    """

def get_futures_dominate(symbol, date):
    """
    获取某个日期的某个品种的主力合约代码，以主力持仓来划分，该品种持仓量连续三日最大且为远期合约时，主力合约会进行切换 
    :param symbol: 品种名称 . 例如：symbol='RB'
    :param date: 获取主力合约的时间 . 时间格式: '%Y%m%d'
    """

def get_future_code(symbol,date):
    """
    获取当前品种所有可交易的期货合约 
    :param symbol: 品种名称 . 例如：symbol='LF'
    :param date: 获取主力合约的时间 . 时间格式: '%Y%m%d'
    """

def get_stylefactor(start_date,end_date, datatype, is_panel=True):
    """
    get_stylefactor函数用于获取风险模型数据 
    :param start_date: 开始日期 支持多种日期格式,例如‘20180101’,2018-01-01,2018/01/01
    :param end_date: 结束日期 支持多种日期格式,例如‘20180101’,2018-01-01,2018/01/01
    :param datatype: 风险参数项 支持以下三种：1.exposure  因子暴露度；2.factor_ret  因子收益率；3.specific_ret  特质因子收益率
    :param is_panel: 返回数据格式 is_panel 为1时，输出的数据格式为panel；is_panel 为0时，输出格式格式为dict；panel返回的数据格式中， x轴为日期，y和z为dataframe，分别为股票代码和暴露度；dict返回的字典，key为时间，值为dataframe,分别为股票代码和暴露度<br>注意：is_panel参数只有当datatype参数为exposure时才可生效
    """

def write_file(path, content, append=False):
    """
    write_file是保存文件函数，将内容保存到研究模块中的文件，保存后您可以立即在研究模块中看到这个文件. 
    :param path: 相对路径 在我的研究中创建一个文件，并为其取名,例如:'test.txt',则表明保存的内容会在我的研究的test.txt文件中.
    :param content: 保存内容 str格式或者unicode格式, 如果是unicode, 则会使用UTF-8编码再存储.可以是二进制内容.str格式即为字符串格式,例如:'明天会下雨'.
    :param append: 是否是追加模式 当路径不变时，新的内容是否覆盖旧的内容.
    """

def read_file(path):
    """
    read_file是读取文件函数，将我的研究模块中的文件读取到回测环境或者模拟交易环境,然后进行使用. 
    :param path: 相对路径 对应“我的研究”中私有文件目录,格式为：'文件夹名/文件名',若在“我的研究”根目录下方，则直接为文件名
    """

def notify_push(content, channel='wxpusher', subject='SuperMind消息提醒', email_list=None, uids=None, topic_ids=None, group_id=None):
    """
    notify_push是消息推送函数，在研究环境、策略编辑等模块均可使用，目前支持微信推送 
    :param content: 消息内容 格式为字符串，如'报错'
    :param uids: 用户的UID 关注公众号，点击“我的－我的UID”获取用户UID信息
    """