跳转至

期权

期权合约详情、期权链、按到期日/类型筛选等。

期权数据客户端方法集合,对应 /api/option/* 端点。

get_option_detail(option_code: str) -> dict

获取期权合约详情。

底层调用 xtdata.get_option_detail(),返回期权合约的详细信息, 包括标的代码、行权价、到期日、合约乘数、期权类型等。

参数:

名称 类型 描述 默认
option_code str

期权合约代码,如 "10005765.SHO"

必需

返回:

类型 描述
dict

期权合约详情字典

get_option_chain(undl_code: str) -> dict

获取标的的完整期权链(T 型报价)。

底层调用 xtdata.get_option_chain(),返回指定标的资产的全部 期权合约,按到期日和行权价组织为 T 型结构。

参数:

名称 类型 描述 默认
undl_code str

标的资产代码,如 "510050.SH"(50ETF)

必需

返回:

类型 描述
dict

期权链数据字典,按到期月份和行权价组织

get_option_list(undl_code: str, dedate: str, opttype: str = '', isavailable: bool = False) -> list

按条件筛选期权合约列表。

底层调用 xtdata.get_option_list(),根据标的、到期日、 期权类型等条件筛选期权合约。

参数:

名称 类型 描述 默认
undl_code str

标的资产代码

必需
dedate str

到期月份,格式 "2312"(2023年12月)

必需
opttype str

期权类型 — "CALL"/"PUT",为空则返回全部

''
isavailable bool

仅返回当前可交易的合约

False

返回:

类型 描述
list

期权合约代码列表

get_history_option_list(undl_code: str, dedate: str) -> list

获取历史期权合约列表(含已到期合约)。

底层调用 xtdata.get_history_option_list(),返回包括已到期 合约在内的历史期权列表,适合期权历史数据分析。

参数:

名称 类型 描述 默认
undl_code str

标的资产代码

必需
dedate str

到期月份

必需

返回:

类型 描述
list

历史期权合约代码列表