Fred Search
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FredSearch | FredSearchQueryParams | FredSearchData |
Import Statement
from openbb_core.provider.standard_models. import (
FredSearchData,
FredSearchQueryParams,
)
Parameters
- standard
- fred
query: str
The search word(s).
• Optional: True
query: str
The search word(s).
• Optional: True
search_type: Literal['full_text', 'series_id', 'release']
The type of search to perform. Automatically set to 'release' when a 'release_id' is provided.
• Default: full_text
• Optional: True
release_id: Annotated[int, Ge(ge=0)]
A specific release ID to target.
• Optional: True
limit: Annotated[int, Ge(ge=0)]
The number of data entries to return. (1-1000)
• Optional: True
offset: Annotated[int, Ge(ge=0)]
Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'.
• Default: 0
• Optional: True
order_by: Literal['search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity']
Order the results by a specific attribute. The default is 'observation_end'.
• Default: observation_end
• Optional: True
sort_order: Literal['asc', 'desc']
Sort the 'order_by' item in ascending or descending order. The default is 'desc'.
• Default: desc
• Optional: True
filter_variable: Literal['frequency', 'units', 'seasonal_adjustment']
Filter by an attribute.
• Optional: True
filter_value: str
String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'.
• Optional: True
tag_names: Union[str, list[str]]
A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple items allowed for provider(s): fred.
• Optional: True
exclude_tag_names: Union[str, list[str]]
A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. This parameter is ignored when search_type is 'release'. Multiple items allowed for provider(s): fred.
• Optional: True
series_id: str
A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.
• Optional: True
Data
- standard
- fred
release_id: str
The release ID for queries.
series_id: str
The series ID for the item in the release.
series_group: str
The series group ID of the series. This value is used to query for regional data.
region_type: str
The region type of the series.
name: str
The name of the release.
title: str
The title of the series.
observation_start: date
The date of the first observation in the series.
observation_end: date
The date of the last observation in the series.
frequency: str
The frequency of the data.
frequency_short: str
Short form of the data frequency.
units: str
The units of the data.
units_short: str
Short form of the data units.
seasonal_adjustment: str
The seasonal adjustment of the data.
seasonal_adjustment_short: str
Short form of the data seasonal adjustment.
last_updated: datetime
The datetime of the last update to the data.
popularity: int
Popularity of the series
group_popularity: int
Group popularity of the release
realtime_start: date
The realtime start date of the series.
realtime_end: date
The realtime end date of the series.
notes: str
Description of the release.
press_release: bool
If the release is a press release.
url: str
URL to the release.
release_id: str
The release ID for queries.
series_id: str
The series ID for the item in the release.
series_group: str
The series group ID of the series. This value is used to query for regional data.
region_type: str
The region type of the series.
name: str
The name of the release.
title: str
The title of the series.
observation_start: date
The date of the first observation in the series.
observation_end: date
The date of the last observation in the series.
frequency: str
The frequency of the data.
frequency_short: str
Short form of the data frequency.
units: str
The units of the data.
units_short: str
Short form of the data units.
seasonal_adjustment: str
The seasonal adjustment of the data.
seasonal_adjustment_short: str
Short form of the data seasonal adjustment.
last_updated: datetime
The datetime of the last update to the data.
popularity: int
Popularity of the series
group_popularity: int
Group popularity of the release
realtime_start: date
The realtime start date of the series.
realtime_end: date
The realtime end date of the series.
notes: str
Description of the release.
press_release: bool
If the release is a press release.
url: str
URL to the release.