数据下载

触发服务端数据下载任务：历史 K 线、财务数据、板块、ETF、期权等。

数据下载客户端方法集合，对应 /api/download/* 端点。

download_batch(stocks: list[str], period: str = '1d', start_time: str = '', end_time: str = '') -> dict

触发服务端批量下载历史行情数据。

底层调用 xtdata.download_history_data2()，向行情服务器请求下载 指定股票在时间范围内的历史 K 线数据到服务端本地。

此接口为异步操作，下载任务在服务端后台执行。可通过 WebSocket /ws/download_progress 端点实时跟踪下载进度。

参数：

名称	类型	描述	默认
stocks	list[str]	股票代码列表，如 ["000001.SZ", "600519.SH"]	必需
period	str	K 线周期，如 "1d"/"1m"/"5m"	'1d'
start_time	str	开始时间，格式 "20230101"	''
end_time	str	结束时间，格式同上	''

返回：

类型	描述
dict	下载任务状态信息

download_sector_data() -> dict

下载板块成分数据。

底层调用 xtdata.download_sector_data()，下载全部板块（行业/概念等） 的成分股数据到服务端本地。建议定期执行以保持板块数据最新。

Note

服务端会在启动时自动执行此下载，之后每 24 小时定时刷新， 客户端通常无需手动调用。

返回：

类型	描述
dict	下载结果信息

download_index_weight() -> dict

下载指数成分权重数据。

底层调用 xtdata.download_index_weight()，下载全部指数的成分股 权重数据。下载后可通过 get_index_weight() 查询。

Note

服务端会在启动时自动执行此下载，之后每 24 小时定时刷新， 客户端通常无需手动调用。

返回：

类型	描述
dict	下载结果信息

download_etf_info() -> dict

下载 ETF 申赎信息。

底层调用 xtdata.download_etf_info()，下载 ETF 基金的申购赎回清单 数据。下载后可通过 get_etf_info() 查询。

Note

服务端会在启动时自动执行此下载，之后每 24 小时定时刷新， 客户端通常无需手动调用。

返回：

类型	描述
dict	下载结果信息

download_cb_data() -> dict

下载可转债数据。

底层调用 xtdata.download_cb_data()，下载全部可转债的基本信息 和转股价格等数据。

Note

服务端会在启动时自动执行此下载，之后每 24 小时定时刷新， 客户端通常无需手动调用。

返回：

类型	描述
dict	下载结果信息

download_history_contracts() -> dict

下载历史合约数据（含已到期合约）。

底层调用 xtdata.download_history_contracts()，下载已到期的 期货/期权合约列表数据，用于历史数据回测。

Note

服务端会在启动时自动执行此下载，之后每 24 小时定时刷新， 客户端通常无需手动调用。

返回：

类型	描述
dict	下载结果信息

download_financial_data2(stocks: list[str], tables: list[str] | None = None) -> dict

同步下载财务数据（阻塞直至完成）。

底层调用 xtdata.download_financial_data2()，与异步版本 download_financial() 不同，此方法会阻塞等待下载完成后再返回。

参数：

名称	类型	描述	默认
stocks	list[str]	股票代码列表	必需
tables	list[str] | None	财务表名列表，如 ["Balance", "Income"]，为空则下载全部	None

返回：

类型	描述
dict	下载结果信息

download_metatable_data() -> dict

下载合约元数据表（期货合约品种信息）。

底层调用 xtdata.download_metatable_data()，下载期货等品种的 合约元数据信息表。

重要: 在查询期货合约列表或获取主力合约前必须先调用此方法， 否则无法识别期货品种。

返回：

类型	描述
dict	下载结果信息

download_holiday_data() -> dict

下载节假日日历数据。

底层调用 xtdata.download_holiday_data()，下载交易所公布的 节假日日历数据到服务端。

Note

服务端会在启动时自动执行此下载，之后每 24 小时定时刷新， 客户端通常无需手动调用。

返回：

类型	描述
dict	下载结果信息

download_his_st_data(stocks: list[str], period: str = '1d', start_time: str = '', end_time: str = '') -> dict

下载历史 ST 数据。

底层调用 xtdata.download_his_st_data()，下载指定股票在时间范围内的 历史 ST（特别处理）标记数据到服务端本地。

参数：

名称	类型	描述	默认
stocks	list[str]	股票代码列表，如 ["000001.SZ", "600519.SH"]	必需
period	str	K 线周期，如 "1d"/"1m"/"5m"	'1d'
start_time	str	开始时间，格式 "20230101"	''
end_time	str	结束时间，格式同上	''

返回：

类型	描述
dict	下载结果信息

download_tabular_data(tables: list[str]) -> dict

下载表格数据。

底层调用 xtdata.download_tabular_data()，下载指定表名的表格数据 到服务端本地。此方法为同步阻塞操作，会等待下载完成后返回。

参数：

名称	类型	描述	默认
tables	list[str]	需要下载的表名列表	必需

返回：

类型	描述
dict	下载结果信息