mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-12 20:31:18 +00:00
3b7f18f91c
* obbject params stored as a list of dict platform markdown generator processes obbject returns into a string * process field types further * process field type correctly * fixed models * mypy suggestion was sus * updated assets and packages --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
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