`sources` module

The sources module provides functions to request data from the FRED API Sources endpoints.

The FRED database contains many sources of data. The sources module provides functions to query the FRED database for information about the available sources.

SourceApiParameters

Bases: BaseModel

Represents the parameters accepted by the FRED Sources endpoints.

get_source

get_source(source_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType) -> JsonType

Get a source of economic data. https://fred.stlouisfed.org/docs/api/fred/source.html.

Parameters:

Name	Type	Description	Default
`source_id`	`int`	Source 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 `source/` endpoint. Refer to the FRED documentation for a list of all possible parameters.	`{}`

Returns:

Type	Description
`Dictionary representing the Json response`

get_source_release

get_source_release(source_id: int, api_key: ApiKeyType = None, **kwargs: KwargsType)

Get the releases for a source. Endpoint documentation.

Parameters:

Name	Type	Description	Default
`source_id`	`int`	Source 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 `source/releases` endpoint. Refer to the FRED documentation for a list of all possible parameters.	`{}`

Returns:

Type	Description
`Dictionary representing the Json response`

get_sources

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

Get all sources 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 `sources/` endpoint. Refer to the FRED documentation for a list of all possible parameters.	`{}`

Returns:

Type	Description
`Dictionary representing the Json response`