FinanceDatabase / Architecture

FinanceDatabase 架构:show / select / search 三系 API 体系

FinanceDatabase 的 API 围绕三件事展开:show 系列展示某类证券、select 系列按条件筛选、search 系列按名称搜索。三者都返回 pandas DataFrame,理解这三系 API 就能读懂绝大多数查询脚本。

show_*:展示证券select_*:筛选证券search_products:搜索
show_*展示证券列表
select_*按条件筛选
search_products按名称搜索
FinanceDatabase API 体系示意(基于官方 README,非官方架构图)。
API Overview

三系 API 对照

FinanceDatabase 的 API 划分与各自职责。

系列职责典型函数
show_*展示某类证券完整列表show_equities() / show_etfs() / show_funds()
select_*按条件筛选证券select_equities(country=, sector=, industry=, market_cap=)
search_products按名称模糊搜索search_products("Apple")
说明:所有查询均返回 pandas DataFrame,可进一步过滤、排序、导出。
show 系列

展示证券列表

show 系列用于一次性获取某类证券的完整列表。

函数返回内容
show_equities()全部股票列表
show_etfs()全部 ETF 列表
show_funds()全部基金列表
show_indices()全部指数列表
show_currencies()货币/外汇列表
show_cryptocurrencies()加密货币列表
show_moneymarkets()货币市场工具列表
select 系列

按条件筛选证券

select 系列用于按维度筛选,是 FinanceDatabase 的核心用法。

参数含义示例
country按国家筛选country="United States"
sector按板块筛选sector="Technology"
industry按行业筛选industry="Software - Infrastructure"
market_cap按市值规模筛选market_cap="Large Cap"
Scenarios

架构适用场景与选型

这套 show/select/search 架构最适合的场景。

批量获取证券代码

一次性拿到某国/某行业全部股票代码,供后续行情分析。

构建证券池

按行业/市值筛选,快速构建研究用证券池。

数据工程管道

作为数据管道的第一环,输出代码清单给 FinanceToolkit 或 yfinance。

边界:FinanceDatabase 只提供证券代码与元数据,不提供行情价格;详见功能页。
FAQ

架构常见问题

show 和 select 有什么区别?

show 展示某类证券的完整列表;select 按 country/sector/industry/market_cap 等条件筛选子集。

返回的数据是什么格式?

pandas DataFrame,列含证券名称、代码、国家、行业、市值、货币等元数据。

能跨类别搜索吗?

可以,search_products 默认跨类别搜索,也可用 database 参数限定类别。

API 是否稳定?

show/select/search 三系是稳定的核心接口;具体字段依赖数据源,详见数据页。

下一步

理解 API 体系后,看首次运行示例,或直接看筛选与搜索实战。