Composite Leading Indicator
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
CompositeLeadingIndicator | CompositeLeadingIndicatorQueryParams | CompositeLeadingIndicatorData |
Import Statement
from openbb_core.provider.standard_models.composite_leading_indicator import (
CompositeLeadingIndicatorData,
CompositeLeadingIndicatorQueryParams,
)
Parameters
- standard
- oecd
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 |
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 |
country | Union[Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str], List[Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str]]] | Country to get the CLI for, default is G20. Multiple items allowed for provider(s): oecd. | g20 | True |
adjustment | Literal['amplitude', 'normalized'] | Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude. | amplitude | True |
growth_rate | bool | Return the 1-year growth rate (%) of the CLI, default is False. | False | True |
Data
- standard
- oecd
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
value | float | CLI value |
country | str | Country for the CLI value. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
value | float | CLI value |
country | str | Country for the CLI value. |