fomc_documents
Get FOMC documents by year and document type. Optionally, download the file directly from the Federal Reserve's website.
Source: https://www.federalreserve.gov/monetarypolicy/fomc_historical.htm Source: https://www.federalreserve.gov/monetarypolicy/fomccalendars.htm
This function does not return the typical OBBject response.
The response is list[dict[str, str]] of FOMC documents and their URLs.
Each dictionary entry has keys: date, url, doc_type, and doc_format.
If as_choices is True, the response is a list of valid Workspace parameter choices.
Keys, label and value, correspond with the doc_type + date, and the url, respectively.
If url was provided, the response is a dict[str, Any] with keys filename, content, and data_format.
Examples
from openbb import obb
obb.economy.fomc_documents(provider='federal_reserve')
# Filter all documents by year.
obb.economy.fomc_documents(provider='federal_reserve', year=2022)
# Filter all documents by year and document type.
obb.economy.fomc_documents(provider='federal_reserve', year=2022, document_type=minutes)
# The `url` parameter will override all other parameters to download the document. The response will be a dictionary with keys `filename`, `content`, and `data_format`. PDF content will be a base64 encoded string of the document.
obb.economy.fomc_documents(provider='federal_reserve', url=https://www.federalreserve.gov/monetarypolicy/files/fomcminutes20220126.pdf)
Parameters
- standard
- federal_reserve
year: int
The year of FOMC documents to retrieve. If None, all years since 1959 are returned.
• Optional: True
document_type: str
Filter by document type. Default is all. Choose from: all, monetary_policy, minutes, projections, materials, press_release, press_conference, conference_call, agenda, transcript, speaker_key, beige_book, teal_book, green_book, blue_book, red_book
• Optional: True
pdf_only: bool
Whether to return as a list with only the PDF documents. Default is False.
• Default: False
• Optional: True
as_choices: bool
Whether to return cast as a list of valid Workspace parameter choices. Leave as False for typical use.
• Default: False
• Optional: True
url: str
Download a document from the supplied URL. When provided, all other parameters are ignored. Content is returned as a base64 encoded string.
• Optional: True
Returns
results: list[FomcDocuments]
Serializable results.
provider: Optional[Literal['federal_reserve']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- federal_reserve
content: Any
The content of request results. If url was provided, the content is a dictionary with keys filename and content. Otherwise, it is a list of dictionaries with a mapping of FOMC documents to URLs. The endpoint response will not be an OBBject.results object, but the content directly.