OpenBB SDK

Pre-requisites

To install and use you need:

To develop you need:

This will install the SDK in the virtual environment.

When working with the source code of the SDK it is required to create the static python interface:

import openbb
openbb._rebuild_python_interface()
exit()

Import and basic usage:

from openbb import obb
aapl = obb.stocks.load(symbol="AAPL", start_date="2020-01-01", provider="fmp")
df = aapl.to_dataframe()
df.head()

API keys:

To connect to APIs you need to provide the API keys.

Launch the API with:

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

Navigate to http://0.0.0.0:8000/docs to see the swagger API documentation.

Authorize with the developer credentials: openbb/openbb

From the root of the OpenBB Terminal repo run:

poetry install -C ./openbb_sdk

When developing a specific extension cd into the extension folder and run:

poetry install