ESTR
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
ESTR | ESTRQueryParams | ESTRData |
Import Statement
from openbb_core.provider.standard_models.estr_rates import (
ESTRData,
ESTRQueryParams,
)
Parameters
- standard
- fred
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True |
parameter | Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume'] | Period of ESTR rate. | volume_weighted_trimmed_mean_rate | True |
Data
- standard
- fred
Name | Type | Description |
---|---|---|
date | date | The date of the data. |
rate | float | ESTR rate. |
Name | Type | Description |
---|---|---|
date | date | The date of the data. |
rate | float | ESTR rate. |