Files
OpenBB/openbb_platform/providers
Theodore Aptekarev 009699928f Rebrand sdk to platform in code (#5496)
* Relink sdk/sdk -> platform/platform

* Relink sdk -> platform

* Rename folders

* Fix dev_install script

* Fix test generators

* Fix test generators

* Fix test generators

* Organize imports
2023-09-29 10:31:45 +02:00
..

Providers

Supported Providers

All currently supported providers are listed below.

Provider URL
FMP https://financialmodelingprep.com/
Polygon https://polygon.io/
Benzinga https://www.benzinga.com/
FRED https://fred.stlouisfed.org/

Default Provider Configuration

To configure the default providers for each route, edit the .openbb_platform/user_settings.json file in your home directory using the following template:

{
    "defaults": {
        "routes": {
            "/stocks/load": {
                "provider": "fmp"
            },
            "/stocks/fa/balance": {
                "provider": "polygon"
            },
            ...
        }
    }
}

Provider Information

Every provider is located within a directory, with the following structure:

openbb_platform
└───providers
    └───<provider_name>
        |   README.md
        │   pyproject.toml
        │   poetry.lock
        |───tests
        └───openbb_<provider_name>
            │   __init__.py
            |───models
            |   |───<some model>.py
            |   └───...
            └───utils
                |───<some helper>.py
                └───...

The models define the data structures that are used to query the provider endpoints and store the response data.