问题描述
jqdatasdk,怎么查看具体的函数的参数,有文档吗?比如get_price()函数中有ecurity=,frequency=参数,其他参数怎么查看
解决方案
在使用 JoinQuant(聚宽)的本地化数据服务 jqdatasdk 时,函数的参数和用法与聚宽官网的 API 文档是高度一致的。您可以通过官方 API 文档或 Python 内置的帮助函数来查看具体的参数详情。
1. 官方 API 文档查看
聚宽提供了非常详细的官方 API 文档。以您提到的 get_price() 函数为例,它的完整参数签名如下:
get_price(security, start_date=None, end_date=None, frequency='daily', fields=None, skip_paused=False, fq='pre', count=None, panel=True, fill_paused=True)
详细参数说明:
security: 一支股票代码或者一个股票代码的 list(如'000001.XSHE'或['000001.XSHE', '600000.XSHG'])。count: 与start_date二选一,不可同时使用。表示获取end_date之前几个frequency的数据。start_date: 开始时间,字符串或者 datetime 对象。与count二选一。end_date: 结束时间,默认是'2015-12-31',包含此日期。frequency: 单位时间长度,支持'Xd','Xm','daily'(等同于'1d'),'minute'(等同于'1m')。默认值是'daily'。fields: 字符串 list,选择要获取的行情数据字段,默认包含['open', 'close', 'high', 'low', 'volume', 'money']等。skip_paused: 是否跳过不交易日期(包括停牌、未上市或者退市后的日期)。默认为False。fq: 复权选项。'pre'为前复权(默认),None为不复权,'post'为后复权。panel: 在 pandas 0.25 版后已被移除,获取多标的数据时建议设置panel=False,返回等效的 dataframe。fill_paused: 对于停牌股票的价格处理,默认为True(用 pre_close 价格填充);False表示使用 NAN 填充。
2. 在 Python 代码中直接查看(推荐)
如果您正在使用 Jupyter Notebook、IPython 或普通的 Python IDE,可以直接使用 Python 的内置方法查看函数说明,无需每次都去翻网页文档:
方法一:使用 help() 函数
from jqdatasdk import *
auth('您的账号', '您的密码')
# 打印 get_price 函数的详细帮助文档
help(get_price)
方法二:在 Jupyter Notebook 中使用 ?
# 在 Jupyter 单元格中运行,会弹出详细的参数和 Docstring
get_price?
总结
jqdatasdk 的所有数据获取函数(如 get_price, get_fundamentals, get_bars 等)的参数定义均可在聚宽官网的 API 文档中的“数据获取函数”章节找到。日常编写代码时,善用 help() 函数是最高效的查阅方式。