composite_leading_indicator
Get the composite leading indicator (CLI).
It is designed to provide early signals of turning points in business cycles showing fluctuation of the economic activity around its long term potential level.
CLIs show short-term economic movements in qualitative rather than quantitative terms.
Examples
from openbb import obb
obb.economy.composite_leading_indicator(provider='oecd')
obb.economy.composite_leading_indicator(country=all, provider='oecd', growth_rate=True)
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 |
Returns
OBBject
results : List[CompositeLeadingIndicator]
Serializable results.
provider : Optional[Literal['oecd']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
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. |