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
- standard
- fred
Name | Type | Description | Default | Optional |
---|---|---|---|---|
release_id | str | The ID of the release. Use fred_search to find releases. | False | |
element_id | str | The element ID of a specific table in the release. | None | True |
date | Union[Union[None, date, str], List[Union[None, date, str]]] | A specific date to get data for. Multiple items allowed for provider(s): fred. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
release_id | str | The ID of the release. Use fred_search to find releases. | False | |
element_id | str | The element ID of a specific table in the release. | None | True |
date | Union[Union[None, date, str], List[Union[None, date, str]]] | A specific date to get data for. Multiple items allowed for provider(s): fred. | None | True |
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
- standard
- fred
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
level | int | The indentation level of the element. |
element_type | str | The type of the element. |
line | int | The line number of the element. |
element_id | str | The element id in the parent/child relationship. |
parent_id | str | The parent id in the parent/child relationship. |
children | str | The element_id of each child, as a comma-separated string. |
symbol | str | Symbol representing the entity requested in the data. |
name | str | The name of the series. |
value | float | The reported value of the series. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
level | int | The indentation level of the element. |
element_type | str | The type of the element. |
line | int | The line number of the element. |
element_id | str | The element id in the parent/child relationship. |
parent_id | str | The parent id in the parent/child relationship. |
children | str | The element_id of each child, as a comma-separated string. |
symbol | str | Symbol representing the entity requested in the data. |
name | str | The name of the series. |
value | float | The reported value of the series. |