by_region
BLS Consumer Price Index chart — Consumer Price Index by Region and Division — 12-Month % Change.
Examples
from openbb import obb
obb.bls.cpi.by_region(provider='bls')
Parameters
- standard
- bls
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
Returns
results: BlsCpiByRegion
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
south: float | None
South.
west: float | None
West.
midwest: float | None
Midwest.
northeast: float | None
Northeast.
south_atlantic: float | None
South Atlantic.
mountain: float | None
Mountain.
east_north_central: float | None
East North Central.
new_england: float | None
New England.
east_south_central: float | None
East South Central.
pacific: float | None
Pacific.
west_north_central: float | None
West North Central.
middle_atlantic: float | None
Middle Atlantic.
west_south_central: float | None
West South Central.
date: date | str
Observation month (first of month).
chart: str
Chart key.
chart_title: str
Full BLS chart title.
table_id: str
Source table id.