Installation / First run

先选入口,再安装 OpenBB

Python、CLI、REST API、MCP 和桌面端共享平台基础,但依赖、命令和授权边界不同。下面按目标工作流给出可核验的起点。

Install routes

OpenBB 安装入口:Python、CLI、MCP 与桌面端

Python 基础包

Shellpip install openbb

适合 Notebook、脚本和只读数据研究。首次查询前仍需按目标 Provider 配置凭据。

完整扩展

Shellpip install "openbb[all]"

需要更多领域扩展或本地开发时再选择更大的依赖范围,并记录版本。

CLI

Shellpip install openbb-cli   openbb

CLI README 将它描述为 OpenBB Platform 的命令行封装,支持交互和 Routine Scripts。

MCP Server

Shellpip install openbb-mcp-server   openbb-mcp

适合 MCP 客户端和 agent 工作流;工具类别、Provider 和认证仍需单独配置。

Checklist

OpenBB 首次运行前检查清单

  1. 确认 Python 版本

    平台和具体扩展的支持范围可能不同,以当前仓库和发行说明为准。

  2. 选择 Provider

    不同数据源有不同的市场覆盖、API Key、订阅和速率限制。

  3. 设置凭据

    可以使用用户设置文件或在 Python 会话中设置;不要把密钥提交进仓库。

  4. 先跑只读示例

    用官方文档中的查询验证环境,再扩展到自己的研究任务。

边界:安装成功不等于数据请求成功;Provider 授权和覆盖范围必须分别确认。

下一步:跑通一个 Python 查询

理解结果对象和 REST launcher,再决定是否需要 CLI 或 MCP。

打开 Python/API 指南