Files
OpenBB/openbb_sdk/providers
Pratyush Shukla e7179c8bf0 Core SDK improvements (#5294)
* added `yfinance` data provider

* static files

* `yfinance` model cleanup

* static files

* add tests folder to yfinance

* added `yfinance` in `extensions` `pyproject.toml`

* feature/sdk-v4-cboe-provider: Adds CBOE Provider to SDK V4 (#5300)

* add cboe provider, fix regressions introduced by merge conflict

* black

* black again

* codespell - openbb_sdk/sdk/provider/README.md

* ruff

* ruff again

* static files

* modified `StockNews` date to type datetime

* static file

* cboe cleanup

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
2023-08-11 00:48:03 +05:30
..
2023-08-08 10:09:24 -04:00
2023-08-11 00:48:03 +05:30
2023-08-08 18:42:23 +05:30
2023-08-11 00:48:03 +05:30
2023-07-24 16:07:36 +02:00

Providers

Supported Providers

All currently supported providers are listed below.

Provider
FMP
Polygon
Benzinga
FRED

Default Provider Configuration

To configure the default providers for each route, edit the .openbb_sdk/user_settings.json file in your home directory by adding the defaults section, a routes subsection and for every route, the default provider desired. A sample is shown below.

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

Provider Information

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

openbb_sdk
└───providers
    └───<provider_name>
        |   README.md
        │   `pyproject.toml`
        │   `poetry.lock`
        └───openbb_<provider_name>
            │   `init.py`
            │   <some functionality>.py
            │   ...

The openbb_<provider_name> folder contains the provider's source code. The README.md file contains the provider's documentation. The pyproject.toml and poetry.lock files contain the provider's dependencies.