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
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
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]]]
Default: g20
Country to get the CLI for, default is G20. Multiple items allowed for provider(s): oecd.
adjustment: Literal['amplitude', 'normalized']
Default: amplitude
Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude.
growth_rate: bool
Default: False
Return the 1-year growth rate (%) of the CLI, default is False.
Returns
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
date: date | str
The date of the data.
value: float
CLI value
country: str
Country for the CLI value.
date: date | str
The date of the data.
value: float
CLI value
country: str
Country for the CLI value.