Skip to main content

fred_release_table

Get economic release data by ID and/or element from FRED.

Examples

from openbb import obb
# Get the top-level elements of a release by not supplying an element ID.
obb.economy.fred_release_table(release_id='50', provider='fred')
# Drill down on a specific section of the release.
obb.economy.fred_release_table(release_id='50', element_id='4880', provider='fred')
# Drill down on a specific table of the release.
obb.economy.fred_release_table(release_id='50', element_id='4881', provider='fred')

Parameters

NameTypeDescriptionDefaultOptional
release_idstrThe ID of the release. Use fred_search to find releases.False
element_idstrThe element ID of a specific table in the release.NoneTrue
dateUnion[Union[None, date, str], List[Union[None, date, str]]]A specific date to get data for. Multiple items allowed for provider(s): fred.NoneTrue

Returns

OBBject
results : List[FredReleaseTable]
Serializable results.

provider : Optional[Literal['fred']]
Provider name.

warnings : Optional[List[Warning_]]
List of warnings.

chart : Optional[Chart]
Chart object.

extra : Dict[str, Any]
Extra info.

Data

NameTypeDescription
dateUnion[date, str]The date of the data.
levelintThe indentation level of the element.
element_typestrThe type of the element.
lineintThe line number of the element.
element_idstrThe element id in the parent/child relationship.
parent_idstrThe parent id in the parent/child relationship.
childrenstrThe element_id of each child, as a comma-separated string.
symbolstrSymbol representing the entity requested in the data.
namestrThe name of the series.
valuefloatThe reported value of the series.