seasonal_factors
Fetch BLS CPI revised seasonally-adjusted indexes and seasonal factors.
Examples
from openbb import obb
# Latest BLS CPI revised seasonal factors + adjusted indexes.
obb.bls.cpi.seasonal_factors(provider='bls')
# 2024-vintage seasonal factors (covers 2020-2024).
obb.bls.cpi.seasonal_factors(provider='bls', year=2024)
Parameters
- standard
- bls
year: int | None
Release year of the revised seasonal-adjustment file; None walks back until a published file is found.
Returns
results: BlsCpiSeasonalFactors
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- bls
date: date | str
First day of the calendar month the values apply to.
item_code: str
Short BLS CPI item code.
series_id: str
Full BLS time-series ID.
title: str | None
Human-readable CPI item title.
seasonally_adjusted_index: float | None
Revised seasonally-adjusted index level.
seasonal_factor: float | None
Multiplicative seasonal factor (100.000 = no seasonality).
table_id: str
Source table identifier.
table_name: str
Full BLS table title.