Files
OpenBB/openbb_sdk/providers
Danglewood de310ea7f4 Hotfix/fix-quandl-regression (#5461)
* fix quandl regression

* Update cot_search.py

* return`List[QuandlCotSearchData]` in Fetcher

---------

Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-09-21 15:21:04 +05:30
..
2023-09-20 10:31:44 +01: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_sdk/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_sdk
└───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.