Introduction

The ODP Python Package serves as scaffolding for a unified API that is standardized, consumable, and deployable across multiple mediums simultaneously - REST API, pure Python, Jupyter Notebook, MCP, Docker, OpenBB Workspace, Excel, etc. - from a single source of truth.

With cross-compatibility out-of-the-box, its ready-to-use data connectors, and a wealth of extensions, it lets you concentrate on creating outstanding research reports and applications quickly and easily.

Installation

Packages are distributed via PyPI.

They can be installed in any Python environment with a version between 3.10 and 3.13.

pip install openbb

Go to the installation page for detailed instructions, and see the extensions page for information on individual components.

Looking for a graphical method, or having trouble with virtual environments?

Go to the Open Data Platform to get started.

Documentation Structure

The documentation will be generally targeted towards the user profile - user or developer

Installation
Instructions for installation.
Quick Start Guides
Get started using the ODP Python Package.
Settings
Configure your ODP environment.
Developer Guides
Documentation, guides, and reference material for developers.
Command Reference
Provides detailed information about the command structure, parameters, outputs, examples, and more for the endpoints of ODP Python packages.
Data Model Reference
Provides detailed information about the standard data models used in the Open Data Platform by OpenBB.
FAQs
Provides answers to frequently asked questions.
Licensing
Provides information about the licensing of the Open Data Platform by OpenBB.

User, Developer, or Contributor?

The line between user and developer can be blurry, and is often the same individual.

For the purpose of this documentation, a User represents a person, organization, robot, or other type of end-user consuming the interface(s) as-supplied.

A contributor is someone submitting a pull request to the OpenBB GitHub repository.

Most other use-cases fall somewhere on the development spectrum.

Example Users

• Consuming data or services from published packages via a supported interface.
  • pip install openbb
• General use of from openbb import obb, openbb-api, openbb-mcp, etc.
  • This could be for local development or remote deployment.

Example Developer

• Creating OpenBB extensions or Workspace applications.
• Importing individual components or utility functions.
• Preparing an OpenBB environment, container, or application for non-personal use.

Developer Docs

The developer pages provide an orientation to the codebase, as well as technical details and snippets for working with it.