t3_special_aggregates

CPI News Release Table 3 — CPI-U U.S. city average, special aggregate indexes.

Examples

from openbb import obb
# Latest CPI-U special aggregate indexes.
obb.bls.cpi.t3_special_aggregates(provider='bls')

Parameters

• standard
• bls

date: date | None | str
Reporting month of the CPI release; None resolves to the most recent release.

---

Returns

results: BlsCpiNrTable3

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

level: int | None
Indent depth from the source XLSX.

relative_importance: float | None
Weight as a percent of the parent index.

index_value: float | None
NSA CPI index at the latest reference month (date).

index_value_prior_month: float | None
NSA CPI index one month before date.

index_value_year_ago: float | None
NSA CPI index twelve months before date.

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

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

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

pct_change_1m_sa_prior: float | None
One-month SA percent change ending one month before date.

pct_change_1m_sa_two_back: float | None
One-month SA percent change ending two months before date.

date: date | str
Reference month the row's values apply to (first of month).

label: str | None
BLS expenditure category, item, or area title.

row_index: int | None
Sequential ordering index preserving BLS hierarchy.

footnote: str | None
Resolved footnote text for any (N) markers in label.

table_id: str
Source table identifier.

table_name: str
Full BLS table title.

release_period: str
Reporting month of the source release.