documents

List published BLS PPI PDF documents for the multi-file viewer widget.

Examples

from openbb import obb
# Browse the monthly PPI Detailed Report PDF archive.
obb.bls.ppi.documents(provider='bls', category='detailed_report')
# Detailed Report PDFs for a single year.
obb.bls.ppi.documents(provider='bls', category='detailed_report', year=2024)

Parameters

• standard
• bls

category: str | None
Default: detailed_report
PPI document family. Only the monthly Detailed Report archive is published.

year: int | None
Filter the monthly Detailed Report archive to a single calendar year.

---

Returns

results: BlsPpiDocuments

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 for display in the file picker.

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

category: str
Document family, matching the category query parameter.

date: date | None | str
Reporting month for the monthly Detailed Report.

format: str | None
File format suffix.