fomc_documents
Get lists of FOMC documents by year and document type.
Examples
from openbb import obb
obb.federal_reserve.fomc_documents(provider='federal_reserve')
# Filter all documents by year.
obb.federal_reserve.fomc_documents(provider='federal_reserve', year=2022)
# Filter all documents by year and document type.
obb.federal_reserve.fomc_documents(provider='federal_reserve', year=2022, document_type='minutes')
Parameters
- standard
- federal_reserve
year: int | None
The year of FOMC documents to retrieve. If None, all years since 1959 are returned.
document_type: str | None
Filter by document type. Default is all. Choose from: all, monetary_policy, minutes, projections, materials, press_release, press_conference, agenda, transcript, speaker_key, beige_book, teal_book, green_book, blue_book, red_book
Returns
results: FederalReserveFomcDocuments
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
- federal_reserve
date: date | str
The date of the document, formatted as YYYY-MM-DD.
doc_type: str
The type of the FOMC document.
doc_format: str
The format of the document (e.g., pdf, htm).
url: str
The URL of the document.