OpenBB Platform

Overview

The OpenBB Platform provides a convenient way to access raw financial data from multiple data providers. The package comes with a ready to use REST API - this allows developers from any language to easily create applications on top of OpenBB Platform.

Please find the complete documentation at docs.openbb.co.

Installation

PyPI

The command below provides access to the core functionalities behind the OpenBB Platform, and a selection of sources.

pip install openbb

This will install the core, router modules, and the following data providers:

Extras

These packages are not installed when pip install openbb is run. They are available for installation separately or by running pip install openbb[all].

pip install openbb-equity openbb-yfinance

Python

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

API keys

To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers (listed above).

Here's how to set them:

Local file

Specify the keys directly in the ~/.openbb_platform/user_settings.json file.

Populate this file with the following template and replace the values with your keys:

{
  "credentials": {
    "fmp_api_key": "REPLACE_ME",
    "polygon_api_key": "REPLACE_ME",
    "benzinga_api_key": "REPLACE_ME",
    "fred_api_key": "REPLACE_ME"
  }
}

Runtime

Credentials can be set for the current session only, using the Python interface.

>>> from openbb import obb
>>> obb.user.credentials.fred_api_key = "REPLACE_ME"
>>> obb.user.credentials.polygon_api_key = "REPLACE_ME"

Go to the documentation for more details.

REST API

The OpenBB Platform comes with a ready-to-use REST API built with FastAPI. Start the application using this command:

uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload

API documentation is found under "/docs", from the root of the server address, and is viewable in any browser supporting HTTP over localhost, such as Chrome.

See the documentation for runtime settings and configurations.

Local Development

To develop with the source code, you need to have the following:

• Git
• Python 3.10 - 3.13.
• Virtual Environment with poetry installed.
  • Activate your virtual environment and run, pip install poetry.
• A local copy of the GitHub repository

Install the repository for local development by using the installation script.

1. Activate your virtual environment.
2. Navigate into the openbb_platform folder.
3. Run python dev_install.py -e to install all packages in editable mode.

See the documentation for an overview of the architecture and how to get started building your own extensions.