mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-05 00:42:19 +00:00
63723f7b2c
* remove Literal[None,...] * pylint: disable=unused-argument * change to Filesystem 1K-blocks Used Available Use% Mounted on tmpfs 3257224 3044 3254180 1% /run /dev/nvme0n1p5 491732848 290872352 175808336 63% / tmpfs 16286112 81500 16204612 1% /dev/shm tmpfs 5120 8 5112 1% /run/lock efivarfs 246 66 176 28% /sys/firmware/efi/efivars tmpfs 16286112 0 16286112 0% /run/qemu /dev/nvme0n1p1 262144 60008 202136 23% /boot/efi tmpfs 3257220 15056 3242164 1% /run/user/1000 to avoid misleading linting attr errors
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": {
"/equity/price/historical": {
"provider": "fmp"
},
"/equity/fundamental/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