OpenBB README

The project's README from github.com/openbq-org/OpenBB. As one markdown file: README.md.


Open Data Platform by OpenBB logo Open Data Platform by OpenBB logo

Twitter Discord Shield Open in Dev Containers Open In Colab PyPI

Open Data Platform by OpenBB (ODP) is the open-source toolset that helps data engineers integrate proprietary, licensed, and public data sources into downstream applications like AI copilots and research dashboards.

ODP operates as the "connect once, consume everywhere" infrastructure layer that consolidates and exposes data to multiple surfaces at once: Python environments for quants, OpenBB Workspace and Excel for analysts, MCP servers for AI agents, and REST APIs for other applications.

Logo

Get started with: pip install openbb

from openbb import obb
output = obb.equity.price.historical("AAPL")
df = output.to_dataframe()

Data integrations available can be found here: https://docs.openbb.co/python/reference


OpenBB Workspace

While the Open Data Platform provides the open-source data integration foundation, OpenBB Workspace offers the enterprise UI for analysts to visualize datasets and leverage AI agents. The platform's "connect once, consume everywhere" architecture enables seamless integration between the two.

You can find OpenBB Workspace at https://pro.openbb.co.

Logo

Data integration:

AI Agents integration:

Integrating Open Data Platform to the OpenBB Workspace

Connect this library to the OpenBB Workspace with a few simple commands, in a Python (3.9.21 - 3.12) environment.

Run an ODP backend

pip install "openbb[all]"
openbb-api

This will launch a FastAPI server, via Uvicorn, at 127.0.0.1:6900.

You can check that it works by going to http://127.0.0.1:6900.

Integrate the ODP Backend to OpenBB Workspace

Sign-in to the OpenBB Workspace, and follow the following steps:

CleanShot 2025-05-17 at 09 51 56@2x

  1. Go to the "Apps" tab
  2. Click on "Connect backend"
  3. Fill in the form with: Name: Open Data Platform URL: http://127.0.0.1:6900
  4. Click on "Test". You should get a "Test successful" with the number of apps found.
  5. Click on "Add".

That's it.


Table of Contents

  1. Installation
  2. Contributing
  3. License
  4. Disclaimer
  5. Contacts
  6. Star History
  7. Contributors

1. Installation

The ODP Python Package can be installed from PyPI package by running pip install openbb

or by cloning the repository directly with git clone https://github.com/OpenBB-finance/OpenBB.git.

Please find more about the installation process, in the OpenBB Documentation.

ODP CLI installation

The ODP CLI is a command-line interface that allows you to access the ODP directly from your command line.

It can be installed by running pip install openbb-cli

or by cloning the repository directly with git clone https://github.com/OpenBB-finance/OpenBB.git.

Please find more about the installation process in the OpenBB Documentation.

2. Contributing

There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️)

Become a Contributor

Create a GitHub ticket

Before creating a ticket make sure the one you are creating doesn't exist already among the existing issues

Provide feedback

We are most active on our Discord, but feel free to reach out to us in any of our social media for feedback.

3. License

Distributed under the AGPLv3 License. See LICENSE for more information.

4. Disclaimer

Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment amount, and may not be suitable for all investors.

Before deciding to trade in a financial instrument you should be fully informed of the risks and costs associated with trading the financial markets, carefully consider your investment objectives, level of experience, and risk appetite, and seek professional advice where needed.

The data contained in the Open Data Platform is not necessarily accurate.

OpenBB and any provider of the data contained in this website will not accept liability for any loss or damage as a result of your trading, or your reliance on the information displayed.

All names, logos, and brands of third parties that may be referenced in our sites, products or documentation are trademarks of their respective owners. Unless otherwise specified, OpenBB and its products and services are not endorsed by, sponsored by, or affiliated with these third parties.

Our use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.

5. Contacts

If you have any questions about the platform or anything OpenBB, feel free to email us at [email protected]

If you want to say hi, or are interested in partnering with us, feel free to reach us at [email protected]

Any of our social media platforms: openbb.co/links

6. Star History

This is a proxy of our growth and that we are just getting started.

But for more metrics important to us check openbb.co/open.

Star History Chart

7. Contributors

OpenBB wouldn't be OpenBB without you. If we are going to disrupt financial industry, every contribution counts. Thank you for being part of this journey.

OpenBB (openbq-org/OpenBB)

Searching Database…

74.4K ·GitHub
这是什么?OpenBB 推出的开放数据平台(ODP)是一套开源工具集,可以把专有、授权和公开的金融数据源一次性接入,然后在各处使用:Python、Excel、OpenBB Workspace、通过 MCP 调用的 AI 智能体,或 REST API。
这是 Python 库还是独立应用?它主要是一个 Python 包('pip install openbb'),同时还附带一个单独的命令行工具('openbb-cli'),并且可以作为本地 FastAPI 后端服务器运行,为 OpenBB Workspace 或 Excel 提供数据。
我该怎么把它运行起来?用 'pip install openbb' 安装核心包,或用 'pip install openbb-cli' 安装命令行工具;你也可以直接克隆代码仓库,而不通过 PyPI 安装。
需要什么版本的 Python?要把这个库连接到 OpenBB Workspace,需要 Python 环境版本在 3.9.21 到 3.12 之间。
OpenBB 自己提供金融数据吗?不提供。ODP 是一个连接层,你需要把自己的专有、授权或公开数据源接入其中;OpenBB 还明确声明,通过它展示的数据不一定准确。
AI 智能体也能使用这些数据吗?可以。ODP 通过 MCP 服务器把同样接入的数据提供给 AI 智能体,同时也支持 Python、Excel 和 REST API 访问。
OpenBB Workspace 是什么?它是面向分析师的界面(另外还有 Excel),在你启动 FastAPI 服务器后,可以连接到你本地运行的 ODP 后端。
有命令行界面吗?有。'openbb-cli' 是一个可单独安装的包,可以让你直接在终端中访问 ODP。
我能根据 OpenBB 的金融数据做交易决策吗?项目自身的免责声明提醒,交易风险很高,而且数据不一定准确,因此不应盲目依赖这些数据做出金融决策。
Creator
openbq-org
Size
2.3 GB
Stars
74.4K
Age
5y
Commits · 90 Days