fed_data
Fetch any published Federal Reserve dataset from the Data Download Program.
Examples
from openbb import obb
# Fetch a release's first table.
obb.federal_reserve.fed_data(dataset='H.15', provider='federal_reserve')
# Fetch a specific table within a release.
obb.federal_reserve.fed_data(dataset='H.15', table='Monthly Averages', provider='federal_reserve')
Parameters
- standard
- federal_reserve
dataset: str
The Federal Reserve statistical release to download.
table: str | None
The data table within the release (see list_datasets); defaults to the release's first table.
series: str | None
Optional comma-separated series IDs to filter the table to.
seasonally_adjusted: bool | None
Filter to seasonally adjusted (True) or not seasonally adjusted (False) series; defaults to both, where applicable.
limit: int | None
Default: 1
Return only the most recent N observations per series; the default is the latest observation. Set to 0 or None for the full series. When the full series is already cached, it is sliced from the cache.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
Returns
results: FederalReserveDataDownload
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 observation date.
series_id: str
The DDP series identifier.
value: float | None
The observation value.
title: str | None
Human-readable series description.
unit: str | None
The unit of the value, including scale, e.g. 'Millions of Dollars' or 'Percent: Per Year'. Values are published as-is, not rescaled.
unit_multiplier: str | None
The scale word applied to the value, e.g. 'Millions', 'Billions', or 'Trillions'; None when the value carries no scale.
seasonally_adjusted: bool | None
Whether the series is seasonally adjusted, where applicable.