OpenBB Documentation

1. Project Overview & Quickstart (OpenBB-finance/OpenBB) Copy Chapter

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.

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 Copy Chapter

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.

Data integration:

• You can learn more about adding data to the OpenBB workspace from the docs or this open source repository.

AI Agents integration:

• You can learn more about adding AI agents to the OpenBB workspace from this open source repository.

Integrating Open Data Platform to the OpenBB Workspace Copy Section

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

• Install the packages.

pip install "openbb[all]"

• Start the API server over localhost.

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:

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](#1-installation)
2. [Contributing](#2-contributing)
3. [License](#3-license)
4. [Disclaimer](#4-disclaimer)
5. [Contacts](#5-contacts)
6. [Star History](#6-star-history)
7. [Contributors](#7-contributors)

1. Installation Copy Chapter

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 Copy Section

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 Copy Chapter

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

Become a Contributor Copy Section

• More information on our Developer Documentation.

Create a GitHub ticket Copy Section

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

• Report bug
• Suggest improvement
• Request a feature

Provide feedback Copy Section

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 Copy Chapter

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

4. Disclaimer Copy Chapter

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 Copy Chapter

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 Copy Chapter

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.

7. Contributors Copy Chapter

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.

2. Official Technical Reference & Guides (OpenBB-finance/OpenBB-docs) Copy Chapter

OpenBB Documentation Website

This repository contains the source code for the OpenBB Documentation Website.

The website was built using Docusaurus, a modern static website generator and TailwindCSS as styling solution. It uses algolia search for the search bar.
The final website can be found at https://docs.openbb.co.

Folder Structure Copy Chapter

├── content # Markdown files
│   ├── cli
│   ├── excel
│   ├── platform
│   ├── pro
│   ├── sdk
│   └── workspace
...
├── scripts
│   ├── generate_excel_markdown.py
│   ├── generate_platform_markdown.py
│   └── generate_widgets_library.py
...
├── src # react stuff for website
├── static # static files

Markdown files Copy Section

The markdown files are used to generate the website. The markdown files are located in the content folder. These files are generated with python scripts that can be found in scripts and should not be edited manually.

Syntax sugar Copy Section

Code blocks

Code blocks are generated using the default markdown syntax:

print("Hello World")

To generate a dynamic date for a certain code block (useful for options examples that need to have a valid date), you can use 2022-07-29 as a placeholder. The script will replace it with the third friday of the next month.

/op oichart ticker:AMD expiry:2022-07-29

Run locally Copy Chapter

Prerequisites Copy Section

• Node.js >= 16.13.0
  To check if you have Node.js installed, run this command in your terminal:

node --version # should be v16.13.0 or higher

Install dependencies Copy Section

npm install

Start development server Copy Section

npm start

This command starts a local development server and open up a browser window in http://localhost:3000. Most changes are reflected live without having to restart the server.

Build Copy Section

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service. We use Github Pages to host our website. It's deployed in the gh-pages branch.

Run tests Copy Chapter

pytest tests/website --autodoc

If tests are run locally, the --autodoc flag is required, otherwise tests will be skipped.
To install necessary dependencies for tests, run poetry install -E doc in the root directory of the repository.

Notes Copy Chapter

iFrame Copy Section

We are detecting whether the website is loaded inside an iframe. If it is, we are hiding the header and footer. This is done to have a better integration with our hub website.

Contributing Copy Chapter

We welcome contributions to the OpenBB Documentation Website.