Get the related FRED tags for one or more FRED tags within a release. Optionally, filter results by tag group or search.
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 tag_names parameter, no tags in the exclude_tag_names parameter, and the release set by the release_id parameter. See the related request fred/release/tags.
Series are assigned tags and releases. Indirectly through series, it is possible to get the tags for a release.
This request can return either XML or JSON by setting the file_type parameter to xml or json. Note that the default value of file_type is xml. The API key 'abcdefghijklmnopqrstuvwxyz123456' is for demonstration purposes only. Use a registered API key instead.
https://api.stlouisfed.org/fred/release/related_tags?release_id=86&tag_names=sa;foreign&api_key=abcdefghijklmnopqrstuvwxyz123456
<tags realtime_start="2013-08-14" realtime_end="2013-08-14" order_by="series_count" sort_order="desc" count="7" offset="0" limit="1000">
<tag name="commercial paper" group_id="gen" notes="" created="2012-03-19 10:40:59-05" popularity="55" series_count="2"/>
<tag name="frb" group_id="src" notes="Board of Governors of the Federal Reserve System" created="2012-02-27 10:18:19-06" popularity="90" series_count="2"/>
<tag name="nation" group_id="geot" notes="Country Level" created="2012-02-27 10:18:19-06" popularity="100" series_count="2"/>
<tag name="usa" group_id="geo" notes="United States of America" created="2012-02-27 10:18:19-06" popularity="100" series_count="2"/>
<tag name="weekly" group_id="freq" notes="" created="2012-02-27 10:18:19-06" popularity="82" series_count="2"/>
<tag name="financial" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="70" series_count="1"/>
<tag name="nonfinancial" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="63" series_count="1"/>
</tags>
https://api.stlouisfed.org/fred/release/related_tags?release_id=86&tag_names=sa;foreign&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
{
"realtime_start": "2013-08-14",
"realtime_end": "2013-08-14",
"order_by": "series_count",
"sort_order": "desc",
"count": 7,
"offset": 0,
"limit": 1000,
"tags": [
{
"name": "commercial paper",
"group_id": "gen",
"notes": "",
"created": "2012-03-19 10:40:59-05",
"popularity": 55,
"series_count": 2
},
{
"name": "frb",
"group_id": "src",
"notes": "Board of Governors of the Federal Reserve System",
"created": "2012-02-27 10:18:19-06",
"popularity": 90,
"series_count": 2
},
{
"name": "nation",
"group_id": "geot",
"notes": "Country Level",
"created": "2012-02-27 10:18:19-06",
"popularity": 100,
"series_count": 2
},
{
"name": "usa",
"group_id": "geo",
"notes": "United States of America",
"created": "2012-02-27 10:18:19-06",
"popularity": 100,
"series_count": 2
},
{
"name": "weekly",
"group_id": "freq",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 82,
"series_count": 2
},
{
"name": "financial",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 70,
"series_count": 1
},
{
"name": "nonfinancial",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 63,
"series_count": 1
}
]
}
Read API Keys for more information.
A key or file extension that indicates the type of file to send.
xml = Extensible Markup Language. The HTTP Content-Type is text/xml.
json = JavaScript Object Notation. The HTTP Content-Type is application/json.
The id for a release.
The start of the real-time period. For more information, see Real-Time Periods.
The end of the real-time period. For more information, see Real-Time Periods.
A semicolon delimited list of tag names that series match all of. See the related request fred/release/tags.
A semicolon delimited list of tag names that series match none of.
A tag group id to filter tags by type.
freq = Frequency
gen = General or Concept
geo = Geography
geot = Geography Type
rls = Release
seas = Seasonal Adjustment
src = Source
The words to find matching tags with.
The maximum number of results to return.
Order results by values of the specified attribute.
Sort results is ascending or descending order for attribute values specified by order_by.