This project has been archived by its maintainers, and is no longer receiving any updates.
| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
|---|
 |
| Check our website at openbb.co |
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.
Installation
The command below provides access to the core functionalities behind the OpenBB Platform.
pip install openbb --pre
To install extensions that expand the core functionalities specify the extension name or use all to install all.
# Install single extension, e.g. openbb-charting
pip install openbb[charting] --pre
# Install all available extensions
pip install openbb[all] --pre
The
--preflag is required to install the latest alpha version.
Note: These instruction are specific to v4. For installation instructions and documentation for v3 go to our website.
Python
>>> from openbb import obb
>>> output = obb.equity.price.historical("AAPL")
>>> df = output.to_dataframe()
>>> df.head()
open high low ... change_percent label change_over_time
date ...
2022-09-19 149.31 154.56 149.10 ... 3.46000 September 19, 22 0.034600
2022-09-20 153.40 158.08 153.08 ... 2.28000 September 20, 22 0.022800
2022-09-21 157.34 158.74 153.60 ... -2.30000 September 21, 22 -0.023000
2022-09-22 152.38 154.47 150.91 ... 0.23625 September 22, 22 0.002363
2022-09-23 151.19 151.47 148.56 ... -0.50268 September 23, 22 -0.005027
[5 rows x 12 columns]
API keys
To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:
- OpenBB Hub
- Runtime
- Local file
1. OpenBB Hub
Set your keys at OpenBB Hub and get your personal access token from https://my.openbb.co/app/sdk/pat to connect with your account.
>>> from openbb import obb
>>> openbb.account.login(pat="OPENBB_PAT")
2. Runtime
>>> from openbb import obb
>>> obb.user.credentials.fmp_api_key = "REPLACE_ME"
>>> obb.user.credentials.polygon_api_key = "REPLACE_ME"
>>> # Persist changes in ~/.openbb_platform/user_settings.json
>>> obb.account.save()
3. Local file
You can 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"
}
}
REST API
The OpenBB Platform comes with a ready to use REST API built with FastAPI. Start the application using this command:
uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload
Check openbb-core README for additional info.
Install for development
To develop the OpenBB Platform you need to have the following:
- Git
- Python 3.8 or higher
- Virtual Environment with
poetryandtomlpackages installed- To install these packages activate your virtual environment and run
pip install poetry toml
- To install these packages activate your virtual environment and run
How to install the platform in editable mode?
- Activate your virtual environment
- Navigate into the
openbb_platformfolder - Run
python dev_install.pyto install the packages in editable mode
Release files for openbb-nightly 4.0.0b0.dev202311200010
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| openbb_nightly-4.0.0b0.dev202311200010.tar.gz | 3.6 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openbb_nightly-4.0.0b0.dev202311200010-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.6 MB
Release files / openbb_nightly-4.0.0b0.dev202311200010.tar.gz
| Download URL | openbb_nightly-4.0.0b0.dev202311200010.tar.gz |
|---|---|
| Size | 3.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea35aa0f0a2c0981ade28b32e5bf8f4b457686d5ad2381b9e144942b89c88c35
|
|
BLAKE2b-256 checksum How to use checksums |
ff441f8797c1efb0c21e808c227e3665d135352bd06d22e0d122160978ab3b87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / openbb_nightly-4.0.0b0.dev202311200010-py3-none-any.whl
| Download URL | openbb_nightly-4.0.0b0.dev202311200010-py3-none-any.whl |
|---|---|
| Size | 4.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
730aa399ba32db9961a15999d1fedc639e30c3c46a3188f5fc189d03922f1c9d
|
|
BLAKE2b-256 checksum How to use checksums |
9a0a7205e67b380af0b4bab4acb966d3cac50a22b59a100ace5b2f9cfe68f1b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Security for openbb-nightly 4.0.0b0.dev202311200010
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
