mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 05:52:23 +00:00
80b9759d31
* add classproperty to fetcher and cpi.py * type var bound * validate model in registry map * better exception msg * fix fred mypy and add data_type * typo * specific model validation * specific model validation * reformat error msg * better * msg
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.