documents

List BLS CPI release PDFs for the file viewer (current edition + archive back to May 2002).

Examples

from openbb import obb
# All CPI release PDFs (current + archive back to May 2002).
obb.bls.cpi.documents(provider='bls')
# Only the archive, narrowed to 2024 releases.
obb.bls.cpi.documents(provider='bls', category='archived', start_date='2024-01-01', end_date='2024-12-31')

Parameters

• standard
• bls

category: str | None
Default: all
Which family of BLS CPI release PDFs to enumerate.

start_date: date | None | str
Earliest publication date to include (inclusive). Applies to archived releases only.

end_date: date | None | str
Latest publication date to include (inclusive). Applies to archived releases only.

---

Returns

results: BlsCpiDocuments

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

name: str
Human-readable document title.

url: str
Absolute HTTPS URL to the PDF on bls.gov.

category: str
Document family (current or archived).

date: date | None | str
Release publication date.

format: str | None
File format of the document.