fred_search
Search for FRED series or economic releases by ID or string.
This does not return the observation values, only the metadata.
Use this function to find series IDs for fred_series().
Parameters
- standard
- fred
query: str | None
The search word(s).
query: str | None
The search word(s).
search_type: Literal['full_text', 'series_id', 'release'] | None
Default: full_text
The type of search to perform. Automatically set to 'release' when a 'release_id' is provided.
release_id: int | None
A specific release ID to target.
limit: int | None
The number of data entries to return. (1-1000)
offset: int | None
Default: 0
Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'.
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'] | None
Default: observation_end
Order the results by a specific attribute. The default is 'observation_end'.
sort_order: Literal['asc', 'desc'] | None
Default: desc
Sort the 'order_by' item in ascending or descending order. The default is 'desc'.
filter_variable: Literal['frequency', 'units', 'seasonal_adjustment'] | None
Filter by an attribute.
filter_value: str | None
String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'.
tag_names: str | None
A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'.
exclude_tag_names: str | None
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'.
series_id: str | None
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.
Returns
results: FredSearch
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
release_id: str | None
The release ID for queries.
series_id: str | None
The series ID for the item in the release.
series_group: str | None
The series group ID of the series. This value is used to query for regional data.
region_type: str | None
The region type of the series.
name: str | None
The name of the release.
title: str | None
The title of the series.
observation_start: date | None
The date of the first observation in the series.
observation_end: date | None
The date of the last observation in the series.
frequency: str | None
The frequency of the data.
frequency_short: str | None
Short form of the data frequency.
units: str | None
The units of the data.
units_short: str | None
Short form of the data units.
seasonal_adjustment: str | None
The seasonal adjustment of the data.
seasonal_adjustment_short: str | None
Short form of the data seasonal adjustment.
last_updated: datetime | None
The datetime of the last update to the data.
popularity: int | None
Popularity of the series
group_popularity: int | None
Group popularity of the release
realtime_start: date | None
The realtime start date of the series.
realtime_end: date | None
The realtime end date of the series.
notes: str | None
Description of the release.
press_release: bool | None
If the release is a press release.
url: str | None
URL to the release.
release_id: str | None
The release ID for queries.
series_id: str | None
The series ID for the item in the release.
series_group: str | None
The series group ID of the series. This value is used to query for regional data.
region_type: str | None
The region type of the series.
name: str | None
The name of the release.
title: str | None
The title of the series.
observation_start: date | None
The date of the first observation in the series.
observation_end: date | None
The date of the last observation in the series.
frequency: str | None
The frequency of the data.
frequency_short: str | None
Short form of the data frequency.
units: str | None
The units of the data.
units_short: str | None
Short form of the data units.
seasonal_adjustment: str | None
The seasonal adjustment of the data.
seasonal_adjustment_short: str | None
Short form of the data seasonal adjustment.
last_updated: datetime | None
The datetime of the last update to the data.
popularity: int | None
Popularity of the series
group_popularity: int | None
Group popularity of the release
realtime_start: date | None
The realtime start date of the series.
realtime_end: date | None
The realtime end date of the series.
notes: str | None
Description of the release.
press_release: bool | None
If the release is a press release.
url: str | None
URL to the release.