Fomc Documents
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FomcDocuments | FomcDocumentsQueryParams | FomcDocumentsData |
Import Statement
from openbb_core.provider.standard_models. import (
FomcDocumentsData,
FomcDocumentsQueryParams,
)
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
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.