板块管理¶
板块列表查询、成分股管理、自定义板块创建等。
板块数据客户端方法集合,对应 /api/sector/* 端点。
get_sector_list() -> list[str]
¶
获取所有可用的板块名称列表。
底层调用 xtdata.get_sector_list(),返回系统内置板块和
用户自定义板块的完整名称列表。
返回:
| 类型 | 描述 |
|---|---|
list[str]
|
板块名称列表,如 |
get_sector_info(sector: str = '') -> dict
¶
获取板块元数据信息。
底层调用 xtdata.get_sector_info(),返回板块的层级结构、
父节点等元信息。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector
|
str
|
板块名称,为空时返回所有板块的信息 |
''
|
返回:
| 类型 | 描述 |
|---|---|
dict
|
板块元数据字典 |
get_sector_stocks(sector: str) -> list[str]
¶
获取板块成分股列表(旧版接口)。
底层调用 xtdata.get_stock_list_in_sector(),返回指定板块
当前的全部成分股代码。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector
|
str
|
板块名称,如 |
必需 |
返回:
| 类型 | 描述 |
|---|---|
list[str]
|
成分股代码列表,如 |
get_sector_stocks_v2(sector: str, real_timetag: int = -1) -> list[str]
¶
获取板块成分股列表(支持历史成分查询)。
底层调用 xtdata.get_stock_list_in_sector(sector_name, real_timetag),
当指定 real_timetag 参数时,可查询板块在某一历史时间点的成分股构成,
用于回测时获取当时的真实成分。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector
|
str
|
板块名称 |
必需 |
real_timetag
|
int
|
历史时间戳(毫秒),-1 表示使用最新成分 |
-1
|
返回:
| 类型 | 描述 |
|---|---|
list[str]
|
成分股代码列表 |
create_sector_folder(folder_name: str) -> dict
¶
创建板块文件夹。
底层调用 xtdata.create_sector_folder(),在板块树中创建一个
新的文件夹节点,用于组织自定义板块。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
folder_name
|
str
|
文件夹名称 |
必需 |
返回:
| 类型 | 描述 |
|---|---|
dict
|
操作结果 |
create_sector(sector_name: str, parent_node: str = '') -> dict
¶
创建自定义板块。
底层调用 xtdata.create_sector(),在指定父节点下创建一个
新的自定义板块。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector_name
|
str
|
板块名称 |
必需 |
parent_node
|
str
|
父节点名称,为空时创建在根目录下 |
''
|
返回:
| 类型 | 描述 |
|---|---|
dict
|
操作结果 |
add_sector_stocks(sector_name: str, stocks: list[str]) -> dict
¶
向板块添加成分股。
底层调用 xtdata.add_sector(),将指定股票添加到自定义板块中。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector_name
|
str
|
板块名称 |
必需 |
stocks
|
list[str]
|
要添加的股票代码列表 |
必需 |
返回:
| 类型 | 描述 |
|---|---|
dict
|
操作结果 |
remove_sector_stocks(sector_name: str, stocks: list[str]) -> dict
¶
从板块移除成分股。
底层调用 xtdata.remove_stock_from_sector(),从自定义板块中
移除指定股票。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector_name
|
str
|
板块名称 |
必需 |
stocks
|
list[str]
|
要移除的股票代码列表 |
必需 |
返回:
| 类型 | 描述 |
|---|---|
dict
|
操作结果 |
remove_sector(sector_name: str) -> dict
¶
删除整个板块。
底层调用 xtdata.remove_sector(),删除一个自定义板块及其全部成分股。
注意:内置系统板块不可删除。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector_name
|
str
|
要删除的板块名称 |
必需 |
返回:
| 类型 | 描述 |
|---|---|
dict
|
操作结果 |
reset_sector(sector_name: str, stocks: list[str]) -> dict
¶
重置板块成分股(替换全部)。
底层调用 xtdata.reset_sector(),用新的股票列表完全替换板块
中的现有成分股。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
sector_name
|
str
|
板块名称 |
必需 |
stocks
|
list[str]
|
新的成分股代码列表 |
必需 |
返回:
| 类型 | 描述 |
|---|---|
dict
|
操作结果 |