这个项目能做什么

finra-py是一个非官方、开源的Python客户端库,封装了FINRA API平台。它有意作为一层薄封装存在:请求被映射到FINRA API后,原始的httpx.Response对象直接返回给调用方,不施加任何私有响应或数据模型。其目的是在提供专用FINRA客户端便利性的同时,保留直接HTTP请求的控制权。 该库为用户承担的主要工作是认证。FINRA API使用OAuth 2.0协议,finra-py管理令牌的获取和生命周期,包括为自行保管凭证的应用提供可定制的令牌存储方案。 README中列出了三个API领域的覆盖范围: - Query API数据集,包括股票、固定收益、FINRA、公司、注册信息和TRACE报告卡。 - Notification API数据集,用于FINRA通知事件。 - Submission API工作流,用于监管申报及其他数据,涵盖Form U4、Form U5、Form BR、创建个人、非注册指纹及其他支持流程的创建、验证、提交、更新和检索。 其他已记录的功能包括支持所有凭证类型、模拟数据集、QA测试环境API、服务端异步请求以及客户端的asyncio支持。 安装要求Python 3.11或更高版本,通过`python -m pip install finra-py`完成;包以`import finra`方式导入。完整文档托管于独立站点,README中链接了入门指南、ADR说明和变更日志。 该库坦率说明了局限性:尽管旨在全面覆盖文档中的数据集,但某些FINRA数据集和服务可能根本未通过API暴露,且目前明确不支持fileX API。 开发通过GitHub issues进行,欢迎提交bug报告和特性请求,但目前不接受拉取请求。作者还宣传了围绕FINRA API集成、Web EFT迁移、合规相关工作流和市场数据系统的咨询服务。项目配有CI和覆盖率徽章,测试覆盖Windows、macOS和Linux。 README附带免责声明:该库为非官方项目,未经FINRA认可、关联或赞助;不提供投资建议或交易策略;用户须遵守底层API的服务条款。根据LICENSE文件发行,不提供任何担保。 从分类角度,该项目最适合置于developer-tools(后端/API客户端库),因其实际用途是将监管和市场数据集接入其他系统,data-integration可作为次要归类。