supplemental_tables

Fetch one of the BLS CPI supplemental XLSX tables (C-CPI-U, CPI-W, historical, etc.).

Examples

from openbb import obb
# Latest CPI-U U.S. city average expenditure-category table.
obb.bls.cpi.supplemental_tables(provider='bls')
# Latest C-CPI-U snapshot.
obb.bls.cpi.supplemental_tables(provider='bls', table='c-cpi-u')
# Historical CPI-U index values (back to 1913).
obb.bls.cpi.supplemental_tables(provider='bls', table='historical-cpi-u-index')
# One specific monthly snapshot.
obb.bls.cpi.supplemental_tables(provider='bls', table='cpi-u-us', date='2024-06-01')

Parameters

• standard
• bls

table: str | None
Default: cpi-u-us
Which CPI supplemental table to load.

date: date | None | str
Snapshot month to fetch; None resolves to the most recent published snapshot.

---

Returns

results: BlsCpiSupplementalTables

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
Reference date the row's values apply to.

label: str
Row label from the source XLSX.

indent_level: int | None
Indent depth in the source XLSX.

frequency: str | None
Reference-date frequency: monthly, semiannual, or annual.

index_value: float | None
Unadjusted (NSA) CPI index level at date.

sa_index_value: float | None
Seasonally-adjusted CPI index level at date.

pct_change_1m_nsa: float | None
One-month NSA percent change ending at date.

pct_change_1m_sa: float | None
One-month seasonally-adjusted percent change ending at date.

pct_change_12m: float | None
Twelve-month percent change ending at date.

pct_change_window: float | None
Two-month NSA percent change ending at date.

pct_change_window_start_date: date | None
Start-of-month for the pct_change_window comparison.

relative_importance: float | None
Relative-importance weight as a percent of the parent index.

pricing_schedule: str | None
Pricing-schedule code (M = monthly, S = semiannual, B = bimonthly).

half: str | None
Semiannual half (1st or 2nd) for historical-cpi-u-averages rows.

value_string: str | None
Raw cell text when the source value is not numeric.

snapshot_date: date
Publication month of the source XLSX snapshot.

table_key: str
Which CPI table family this row came from.

table_id: str
Stable identifier for the source (table, snapshot) tuple.

table_name: str
Human-readable BLS table title for the source snapshot.

sheet: str
XLSX sheet name the row was read from.

row_index: int
Sequential ordering index assigned during parsing.

footnote: str | None
Resolved footnote text for any (N) markers attached to the row's label.