by_metro
BLS Consumer Price Index chart — Consumer Price Index by Metropolitan Area — 12-Month % Change.
Examples
from openbb import obb
obb.bls.cpi.by_metro(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: BlsCpiByMetro
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
atlanta: float | None
Atlanta-Sandy Springs-Roswell, GA.
baltimore: float | None
Baltimore-Columbia-Towson, MD.
boston: float | None
Boston-Cambridge-Newton, MA-NH.
chicago: float | None
Chicago-Naperville-Elgin, IL-IN-WI.
dallas: float | None
Dallas-Fort Worth-Arlington, TX.
denver: float | None
Denver-Aurora-Lakewood, CO.
detroit: float | None
Detroit-Warren-Dearborn, MI.
houston: float | None
Houston-The Woodlands-Sugar Land, TX.
los_angeles: float | None
Los Angeles-Long Beach-Anaheim, CA.
miami: float | None
Miami-Fort Lauderdale-West Palm Beach, FL.
minneapolis: float | None
Minneapolis-St. Paul-Bloomington, MN-WI.
new_york: float | None
New York-Newark-Jersey City, NY-NJ-PA.
philadelphia: float | None
Philadelphia-Camden-Wilmington, PA-NJ-DE-MD.
phoenix: float | None
Phoenix-Mesa-Scottsdale, AZ.
riverside: float | None
Riverside-San Bernardino-Ontario, CA.
san_diego: float | None
San Diego-Carlsbad, CA.
san_francisco: float | None
San Francisco-Oakland-Hayward, CA.
seattle: float | None
Seattle-Tacoma-Bellevue, WA.
st_louis: float | None
St. Louis, MO-IL.
tampa: float | None
Tampa-St. Petersburg-Clearwater, FL.
urban_alaska: float | None
Urban Alaska.
urban_hawaii: float | None
Urban Hawaii.
washington_dc: float | None
Washington-Arlington-Alexandria, DC-VA-MD-WV.
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.