releases module

The releases module provides functions to request data from the FRED API Releases endpoints.

ReleaseApiParameters

Bases: BaseModel

Represents the parameters accepted by the FRED Release endpoints.

get_release

get_release(release_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get a release of economic data. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

Example

release_info = get_release(release_id=53)

get_release_dates

get_release_dates(release_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get release dates for a release of economic data. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/dates/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

get_release_related_tags

get_release_related_tags(release_id: int, tag_names: str, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get the related FRED tags for one or more FRED tags within a release. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
tag_names	str	A semicolon delimited list of tag names that series match all of. See the related request fred/release/tags.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/related_tags/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

get_release_series

get_release_series(release_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get the series on a release of economic data. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/release_series/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

get_release_sources

get_release_sources(release_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get the sources for a release of economic data. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/sources/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

get_release_tables

get_release_tables(release_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get release table trees for a given release. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/tables/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

get_release_tags

get_release_tags(release_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get the FRED tags for a release. Endpoint documentation.

Parameters:

Name	Type	Description	Default
release_id	int	Release id of interest.	required
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API release/tags/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response.

get_releases

get_releases(api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get all releases of economic data. Endpoint documentation.

Parameters:

Name	Type	Description	Default
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API releases/ endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response

get_releases_dates

get_releases_dates(api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get release dates for all releases of economic data. Endpoint documentation.

Parameters:

Name	Type	Description	Default
api_key	str | None	FRED API key. Defaults to None. If None, will search for FRED_API_KEY in environment variables.	None
**kwargs	dict	Additional parameters to FRED API releases/dates endpoint. Refer to the FRED documentation for a list of all possible parameters.	{}

Returns:

Type	Description
Dictionary representing the Json response