mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
86f951f1b1
* Argparse custom params POC * small improvements to the package builder * generation of static assets * minor adjustments --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
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.