Federal Reserve Economic Data (Independent Publisher) (Preview)

FRED contains frequently updated US macro and regional economic time series at annual, quarterly, monthly, weekly, and daily frequencies. FRED aggregates economic data from a variety of sources- most of which are US government agencies. The economic time series in FRED contain observation or measurement periods associated with data values.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor, Hitachi Solutions
Website https://fred.stlouisfed.org/
Privacy policy https://research.stlouisfed.org/privacy.html
Categories Data

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this API True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Get a category

Get a category.

Get a release of economic data

Get a release of economic data.

Get a source of economic data

Get a source of economic data.

Get all releases of economic data

Get all releases of economic data.

Get all sources of economic data

Get all sources of economic data.

Get all tags

Get FRED tags. Optionally, filter results by tag name, tag group, or search. FRED tags are attributes assigned to series.

Get an economic data series

Get an economic data series.

Get economic data series sorted by when observations were updated

Get economic data series sorted by when observations were updated on the FRED server. Results are limited to series updated within the last two weeks.

Get economic data series that match search text

Get economic data series that match search text.

Get release dates for a release of economic data

Get release dates for a release of economic data. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

Get release dates for all releases of economic data

Get release dates for all releases of economic data.

Get release table trees for a given release

Get release table trees for a given release. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

Get the categories for an economic data series

Get the categories for an economic data series.

Get the child categories

Get the child categories for a specified parent category.

Get the dates in history when a series' data values were revised

Get the dates in history when a series' data values were revised or new data values were released. Vintage dates are the release dates for a series excluding release dates when the data for the series did not change.

Get the observations or data values for an economic data series

Get the observations or data values for an economic data series.

Get the related categories for a category

A related category is a one-way relation between 2 categories that is not part of a parent-child category hierarchy. Most categories do not have related categories.

Get the related tags for one or more tags

Get the related FRED tags for one or more FRED tags. Optionally, filter results by tag group or search. FRED tags are attributes assigned to series. Related FRED tags are the tags assigned to series that match all tags in the tag_names parameter and no tags in the exclude_tag_names parameter.

Get the related tags for one or more tags matching a series search

Get the related FRED tags for one or more FRED tags matching a series search.

Get the related tags for one or more tags within a release

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

Get the related tags for tags within a category

Get the related FRED tags for one or more FRED tags within a category. FRED tags are attributes assigned to series. For this request, related FRED tags are the tags assigned to series that match all tags in the parameters.

Get the release for an economic data series

Get the release for an economic data series.

Get the releases for a source

Get the releases for a source.

Get the series in a category

Get the series in a category.

Get the series matching tags

Get the series matching all tags in the tag_names parameter and no tags in the exclude_tag_names parameter.

Get the series on a release of economic data

Get the series on a release of economic data.

Get the sources for a release of economic data

Get the sources for a release of economic data.

Get the tags for a category

Get the FRED tags for a category.

Get the tags for a release

Get the FRED tags for a release.

Get the tags for a series

Get the FRED tags for a series.

Get the tags for a series search

Get the FRED tags for a series search.

Get a category

Get a category.

Parameters

Name Key Required Type Description
Category ID
category_id True integer

The identifier for a category.

Returns

Name Path Type Description
Categories
categories array of object

The categories.

ID
categories.id integer

The category identifier.

Name
categories.name string

The name.

Parent ID
categories.parent_id integer

The parent identifier.

Get a release of economic data

Get a release of economic data.

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Releases
releases array of object

The releases.

ID
releases.id integer

The item identifier.

Real-time Start
releases.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
releases.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
releases.name string

The name.

Press Release
releases.press_release boolean

Whether there is a press release.

Link
releases.link string

The link address.

Get a source of economic data

Get a source of economic data.

Parameters

Name Key Required Type Description
Source ID
source_id True integer

The identifier for a source.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Sources
sources array of object

The sources.

ID
sources.id integer

The item identifier.

Real-time Start
sources.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
sources.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
sources.name string

The name.

Link
sources.link string

The link address.

Get all releases of economic data

Get all releases of economic data.

Parameters

Name Key Required Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Releases
releases array of object

The releases.

ID
releases.id integer

The item identifier.

Real-time Start
releases.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
releases.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
releases.name string

The name.

Press Release
releases.press_release boolean

Whether there is a press release.

Link
releases.link string

The link address.

Get all sources of economic data

Get all sources of economic data.

Parameters

Name Key Required Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Sources
sources array of object

The sources.

ID
sources.id integer

The item identifier.

Real-time Start
sources.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
sources.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
sources.name string

The name.

Link
sources.link string

The link address.

Get all tags

Get FRED tags. Optionally, filter results by tag name, tag group, or search. FRED tags are attributes assigned to series.

Parameters

Name Key Required Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get an economic data series

Get an economic data series.

Parameters

Name Key Required Type Description
Series ID
series_id True string

The identifer for a series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Series
seriess array of object

The series.

ID
seriess.id string

The item identifier.

Real-time Start
seriess.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
seriess.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Title
seriess.title string

The title.

Observation Start
seriess.observation_start string

When the observation started.

Observation End
seriess.observation_end string

When the observation ended.

Frequency
seriess.frequency string

The frequency.

Frequency Short
seriess.frequency_short string

The short frequency abbreviation.

Units
seriess.units string

The units.

Units Short
seriess.units_short string

The short unit abbreviation.

Seasonal Adjustment
seriess.seasonal_adjustment string

The seasonal adjustment.

Seasonal Adjustment Short
seriess.seasonal_adjustment_short string

The short seasonal adjustment abbreviation.

Last Updated
seriess.last_updated string

When last updated.

Popularity
seriess.popularity integer

The popularity ranking.

Notes
seriess.notes string

The notes for this item.

Get economic data series sorted by when observations were updated

Get economic data series sorted by when observations were updated on the FRED server. Results are limited to series updated within the last two weeks.

Parameters

Name Key Required Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Filter Value
filter_value string

The value of the filter variable attribute to filter results by.

Start Time
start_time string

The start time.

End Time
end_time string

The end time.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Filter Variable
filter_variable string

The filter variable.

Filter Value
filter_value string

The filter value.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Series
seriess array of object

The series.

ID
seriess.id string

The item identifier.

Real-time Start
seriess.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
seriess.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Title
seriess.title string

The title.

Observation Start
seriess.observation_start string

When the observation started.

Observation End
seriess.observation_end string

When the observation ended.

Frequency
seriess.frequency string

The frequency.

Frequency Short
seriess.frequency_short string

The short frequency abbreviation.

Units
seriess.units string

The units.

Units Short
seriess.units_short string

The short unit abbreviation.

Seasonal Adjustment
seriess.seasonal_adjustment string

The seasonal adjustment.

Seasonal Adjustment Short
seriess.seasonal_adjustment_short string

The short seasonal adjustment abbreviation.

Last Updated
seriess.last_updated string

When last updated.

Popularity
seriess.popularity integer

The popularity ranking.

Get economic data series that match search text

Get economic data series that match search text.

Parameters

Name Key Required Type Description
Search Text
search_text string

The words to find matching tags with.

Search Type
search_type string

Determines the type of search to perform.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Filter Variable
filter_variable string

The attribute to filter results by.

Filter Value
filter_value string

The value of the filter variable attribute to filter results by.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Series
seriess array of object

The series.

ID
seriess.id string

The item identifier.

Real-time Start
seriess.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
seriess.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Title
seriess.title string

The title.

Observation Start
seriess.observation_start string

When the observation started.

Observation End
seriess.observation_end string

When the observation ended.

Frequency
seriess.frequency string

The frequency.

Frequency Short
seriess.frequency_short string

The short frequency abbreviation.

Units
seriess.units string

The units.

Units Short
seriess.units_short string

The short unit abbreviation.

Seasonal Adjustment
seriess.seasonal_adjustment string

The seasonal adjustment.

Seasonal Adjustment Short
seriess.seasonal_adjustment_short string

The short seasonal adjustment abbreviation.

Last Updated
seriess.last_updated string

When last updated.

Popularity
seriess.popularity integer

The popularity ranking.

Group Popularity
seriess.group_popularity integer

The group popularity ranking.

Notes
seriess.notes string

The notes for this item.

Get release dates for a release of economic data

Get release dates for a release of economic data. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Include Releases With No Data
include_release_dates_with_no_data string

Determines whether release dates with no data available are returned. The defalut value 'false' excludes release dates that do not have data. In particular, this excludes future release dates which may be available in the FRED release calendar or the ALFRED release calendar.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Release Dates
release_dates array of object

The release dates.

Release ID
release_dates.release_id integer

The release identifier.

Date
release_dates.date string

The date.

Get release dates for all releases of economic data

Get release dates for all releases of economic data.

Parameters

Name Key Required Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Include Release Dates With No Data
include_release_dates_with_no_data string

Determines whether release dates with no data available are returned. The defalut value 'false' excludes release dates that do not have data. In particular, this excludes future release dates which may be available in the FRED release calendar or the ALFRED release calendar.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Release Dates
release_dates array of object

The release dates.

Release ID
release_dates.release_id integer

The release identifier.

Release Name
release_dates.release_name string

The release name.

Date
release_dates.date string

The date.

Get release table trees for a given release

Get release table trees for a given release. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Element ID
element_id integer

The release table element id you would like to retrieve.

Include Observation Values
include_observation_values string

A flag to indicate that observations need to be returned. Observation value and date will only be returned for a series type element.

Observation Date
observation_date string

The observation date to be included with the returned release table. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Name
name string

The name.

Element ID
element_id integer

The element identifier.

Release ID
release_id string

The release identifier.

element_id
elements.element.element_id integer

The element identifier.

Release ID
elements.element.release_id integer

The release identifier.

Series ID
elements.element.series_id string

The series identifier.

Parent ID
elements.element.parent_id integer

The parent identifier.

Line
elements.element.line string

The line.

Type
elements.element.type string

The type.

Name
elements.element.name string

The name.

Level
elements.element.level string

The level.

Children
elements.element.children array of object

The children.

Element ID
elements.element.children.element_id integer

The element identifier.

Release ID
elements.element.children.release_id integer

The release identifier.

Series ID
elements.element.children.series_id string

The series identifier.

Parent ID
elements.element.children.parent_id integer

The parent identifier.

Line
elements.element.children.line string

The line.

Type
elements.element.children.type string

The type.

Name
elements.element.children.name string

The name.

Level
elements.element.children.level string

The level.

Children
elements.element.children.children array of

The children.

Get the categories for an economic data series

Get the categories for an economic data series.

Parameters

Name Key Required Type Description
Series ID
series_id True string

The identifer for a series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Categories
categories array of object

The categories.

ID
categories.id integer

The item identifier.

Name
categories.name string

The name.

Parent ID
categories.parent_id integer

The parent identifier.

Get the child categories

Get the child categories for a specified parent category.

Parameters

Name Key Required Type Description
Category ID
category_id True integer

The identifier for a category.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Categories
categories array of object

The categories.

ID
categories.id integer

The category identifier.

Name
categories.name string

The category name.

Parent ID
categories.parent_id integer

The parent identifier.

Get the dates in history when a series' data values were revised

Get the dates in history when a series' data values were revised or new data values were released. Vintage dates are the release dates for a series excluding release dates when the data for the series did not change.

Parameters

Name Key Required Type Description
Series ID
series_id True string

The identifer for a series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Vintage Dates
vintage_dates array of string

The vintage dates.

Get the observations or data values for an economic data series

Get the observations or data values for an economic data series.

Parameters

Name Key Required Type Description
Series ID
series_id True string

The identifer for a series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Observation Start
observation_start string

The start of the observation period. YYYY-MM-DD formatted string.

Observation End
observation_end string

The end of the observation period. YYYY-MM-DD formatted string.

Units
units string

A key that indicates a data value transformation.

Frequency
frequency string

An optional parameter that indicates a lower frequency to aggregate values to. The FRED frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). In FRED, the highest frequency data is daily, and the lowest frequency data is annual.

Aggregation Method
aggregation_method string

A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set.

Output Type
output_type integer

An integer that indicates an output type.

Vintage Dates
vintage_dates string

A comma separated string of YYYY-MM-DD formatted dates in history (e.g. 2000-01-01,2005-02-24). Vintage dates are used to download data as it existed on these specified dates in history. Vintage dates can be specified instead of a real-time period using real-time start and real-time end.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

observation_start
observation_start string

The start of the observation period. YYYY-MM-DD formatted string.

observation_end
observation_end string

The end of the observation period. YYYY-MM-DD formatted string.

units
units string

A key that indicates a data value transformation.

Output Type
output_type integer

An integer that indicates an output type.

File Type
file_type string

A key or file extension that indicates the type of file to send.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Observations
observations array of object

The observations.

Real-time Start
observations.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
observations.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Date
observations.date string

The date.

Value
observations.value string

The value.

A related category is a one-way relation between 2 categories that is not part of a parent-child category hierarchy. Most categories do not have related categories.

Parameters

Name Key Required Type Description
Category ID
category_id True integer

The identifier for a category.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Categories
categories array of object

The categories.

ID
categories.id integer

The category identifier.

Name
categories.name string

The category name.

Parent ID
categories.parent_id integer

The parent identifier.

Get the related FRED tags for one or more FRED tags. Optionally, filter results by tag group or search. FRED tags are attributes assigned to series. Related FRED tags are the tags assigned to series that match all tags in the tag_names parameter and no tags in the exclude_tag_names parameter.

Parameters

Name Key Required Type Description
Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get the related FRED tags for one or more FRED tags matching a series search.

Parameters

Name Key Required Type Description
Series Search Text
series_search_text True string

The words to match against economic data series.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Tag Search Text
tag_search_text string

The words to find matching tags with.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

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

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get the related FRED tags for one or more FRED tags within a category. FRED tags are attributes assigned to series. For this request, related FRED tags are the tags assigned to series that match all tags in the parameters.

Parameters

Name Key Required Type Description
Category ID
category_id True integer

The identifier for a category.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get the release for an economic data series

Get the release for an economic data series.

Parameters

Name Key Required Type Description
Series ID
series_id True string

The identifer for a series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Releases
releases array of object

The releases.

ID
releases.id integer

The item identifier.

Real-time Start
releases.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
releases.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
releases.name string

The name.

Press Release
releases.press_release boolean

Whether there is a press release.

Link
releases.link string

The link address.

Get the releases for a source

Get the releases for a source.

Parameters

Name Key Required Type Description
Source ID
source_id True integer

The identifier for a source.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Releases
releases array of object

The releases.

ID
releases.id integer

The item identifier.

Real-time Start
releases.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
releases.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
releases.name string

The name.

Press Release
releases.press_release boolean

Whether there is a press release.

Link
releases.link string

The link address.

Get the series in a category

Get the series in a category.

Parameters

Name Key Required Type Description
Category ID
category_id True integer

The identifier for a category.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Filter Variable
filter_variable string

The attribute to filter results by.

Filter Value
filter_value string

The value of the filter variable attribute to filter results by.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Series
seriess array of object

The series.

ID
seriess.id string

The item identifier.

Real-time Start
seriess.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
seriess.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Title
seriess.title string

The title.

Observation Start
seriess.observation_start string

When the observation started.

Observation End
seriess.observation_end string

When the observation ended.

Frequency
seriess.frequency string

The frequency.

Frequency Short
seriess.frequency_short string

The short frequency abbreviation.

Units
seriess.units string

The units.

Units Short
seriess.units_short string

The short unit abbreviation.

Seasonal Adjustment
seriess.seasonal_adjustment string

The seasonal adjustment.

Seasonal Adjustment Short
seriess.seasonal_adjustment_short string

The short seasonal adjustment abbreviation.

Last Updated
seriess.last_updated string

When last updated.

Popularity
seriess.popularity integer

The popularity ranking.

Group Popularity
seriess.group_popularity integer

The group popularity ranking.

Notes
seriess.notes string

The notes for this item.

Get the series matching tags

Get the series matching all tags in the tag_names parameter and no tags in the exclude_tag_names parameter.

Parameters

Name Key Required Type Description
Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Series
seriess array of object

The series.

ID
seriess.id string

The item identifier.

Real-time Start
seriess.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
seriess.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Title
seriess.title string

The title.

Observation Start
seriess.observation_start string

When the observation started.

Observation End
seriess.observation_end string

When the observation ended.

Frequency
seriess.frequency string

The frequency.

Frequency Short
seriess.frequency_short string

The short frequency abbreviation.

Units
seriess.units string

The units.

Units Short
seriess.units_short string

The short unit abbreviation.

Seasonal Adjustment
seriess.seasonal_adjustment string

The seasonal adjustment.

Seasonal Adjustment Short
seriess.seasonal_adjustment_short string

The short seasonal adjustment abbreviation.

Last Updated
seriess.last_updated string

When last updated.

Popularity
seriess.popularity integer

The popularity ranking.

Group Popularity
seriess.group_popularity integer

The group popularity ranking.

Notes
seriess.notes string

The notes for this item.

Get the series on a release of economic data

Get the series on a release of economic data.

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Filter Variable
filter_variable string

The attribute to filter results by.

Filter Value
filter_value string

The value of the filter variable attribute to filter results by.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Excluded Tag Names
exclude_tag_names string

A semicolon delimited string of tag names that series match none of.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Series
seriess array of object

The series.

ID
seriess.id string

The item identifier.

Real-time Start
seriess.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
seriess.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Title
seriess.title string

The title.

Observation Start
seriess.observation_start string

When the observation started.

Observation End
seriess.observation_end string

When the observation ended.

Frequency
seriess.frequency string

The frequency.

Frequency Short
seriess.frequency_short string

The short frequency abbreviation.

Units
seriess.units string

The units.

Units Short
seriess.units_short string

The short unit abbreviation.

Seasonal Adjustment
seriess.seasonal_adjustment string

The seasonal adjustment.

Seasonal Adjustment Short
seriess.seasonal_adjustment_short string

The short seasonal adjustment abbreviation.

Last Updated
seriess.last_updated string

When last updated.

Popularity
seriess.popularity integer

The popularity ranking.

Group Popularity
seriess.group_popularity integer

The group popularity ranking.

Get the sources for a release of economic data

Get the sources for a release of economic data.

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Sources
sources array of object

The sources.

ID
sources.id integer

The item identifier.

Real-time Start
sources.realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
sources.realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Name
sources.name string

The name.

Link
sources.link string

The link address.

Get the tags for a category

Get the FRED tags for a category.

Parameters

Name Key Required Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get the tags for a release

Get the FRED tags for a release.

Parameters

Name Key Required Type Description
Release ID
release_id integer

The release identifier.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Search Text
search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get the tags for a series

Get the FRED tags for a series.

Parameters

Name Key Required Type Description
Series ID
series_id True string

The identifer for a series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.

Get the FRED tags for a series search.

Parameters

Name Key Required Type Description
Series Search Text
series_search_text True string

The words to match against economic data series.

Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Tag Names
tag_names True string

A semicolon delimited string of tag names that series match all of.

Tag Group ID
tag_group_id string

A tag group identifier to filter tags by type.

Tag Search Text
tag_search_text string

The words to find matching tags with.

Limit
limit integer

The maximum number of results to return.

Offet
offset integer

The requested number offset.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Returns

Name Path Type Description
Real-time Start
realtime_start string

The start of the real-time period. YYYY-MM-DD formatted string.

Real-time End
realtime_end string

The end of the real-time period. YYYY-MM-DD formatted string.

Order By
order_by string

Order results by values of the specified attribute.

Sort Order
sort_order string

Sort results is ascending or descending order for attribute values specified by order by.

Count
count integer

The count of the response

Offset
offset integer

The value offset.

Limit
limit integer

The requested limit.

Tags
tags array of object

The tags.

Name
tags.name string

The name.

Group ID
tags.group_id string

The group identifier.

Notes
tags.notes string

The notes for this item.

Created
tags.created string

When created.

Popularity
tags.popularity integer

The popularity ranking.

Series Count
tags.series_count integer

The series count.