documents
List BLS JOLTS release PDFs / supplementals / archived releases for the file viewer.
Examples
from openbb import obb
# All current JOLTS PDFs + supplemental files.
obb.bls.jolts.documents(provider='bls')
# Every archived national JOLTS release.
obb.bls.jolts.documents(provider='bls', category='archived', release_code='jolts')
Parameters
- standard
- bls
category: str | None
Default: all
Family of BLS JOLTS PDFs to enumerate.
release_code: str | None
Optional release code to restrict the results.
start_date: date | None | str
Earliest publication date to include (inclusive).
end_date: date | None | str
Latest publication date to include (inclusive).
Returns
results: BlsJoltsDocuments
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 file on bls.gov.
category: str
Document family.
release_code: str | None
Source release code.
date: date | None | str
Publication date of the document.
format: str | None
File format of the document.