Files
OpenBB/openbb_platform/providers
Pratyush Shukla 68965c4cec Seprate Intrinio financials data tags into a different command (#5723)
* add `ebit` field in income statement standard model

* only add required data tags

* remove calculations data

* use `name` key instead of `tag` key

* set `period` as required in data

* remove `period` and `cik` from provider models

* add `equity/fundamental/search_financial_attributes` with tests

* clean descriptions file

* add `equity/fundamental/financial_attributes` with tests

* set `value` as `Optional`
2023-11-14 21:59:49 +00:00
..
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00
2023-11-13 15:03:31 +00:00

Providers

Available Providers

See full list of available providers in the PROVIDERS file

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.

See CONTRIBUTING file for more details