fred/release/tags
Description
Get the FRED tags for a release. Optionally, filter results by tag name, tag group, or search. Series are assigned tags and releases. Indirectly through series, it is possible to get the tags for a release. See the related request fred/release/related_tags.
Examples
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.
XML
Request (HTTPS GET)
https://api.stlouisfed.org/fred/release/tags?release_id=86&api_key=abcdefghijklmnopqrstuvwxyz123456
Response
<tags realtime_start="2013-08-14" realtime_end="2013-08-14" order_by="series_count" sort_order="desc" count="13" offset="0" limit="1000"> <tag name="commercial paper" group_id="gen" notes="" created="2012-03-19 10:40:59-05" popularity="55" series_count="18"/> <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="18"/> <tag name="nation" group_id="geot" notes="Country Level" created="2012-02-27 10:18:19-06" popularity="100" series_count="18"/> <tag name="usa" group_id="geo" notes="United States of America" created="2012-02-27 10:18:19-06" popularity="100" series_count="18"/> <tag name="weekly" group_id="freq" notes="" created="2012-02-27 10:18:19-06" popularity="82" series_count="18"/> <tag name="nsa" group_id="seas" notes="Not seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="96" series_count="9"/> <tag name="sa" group_id="seas" notes="Seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="94" series_count="9"/> <tag name="financial" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="70" series_count="6"/> <tag name="nonfinancial" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="63" series_count="6"/> <tag name="domestic" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="69" series_count="4"/> <tag name="foreign" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="58" series_count="4"/> <tag name="asset-backed" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="43" series_count="2"/> <tag name="companies" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="49" series_count="1"/> </tags>
JSON
Request (HTTPS GET)
https://api.stlouisfed.org/fred/release/tags?release_id=86&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
Response
{
"realtime_start": "2013-08-14",
"realtime_end": "2013-08-14",
"order_by": "series_count",
"sort_order": "desc",
"count": 13,
"offset": 0,
"limit": 1000,
"tags": [
{
"name": "commercial paper",
"group_id": "gen",
"notes": "",
"created": "2012-03-19 10:40:59-05",
"popularity": 55,
"series_count": 18
},
{
"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": 18
},
{
"name": "nation",
"group_id": "geot",
"notes": "Country Level",
"created": "2012-02-27 10:18:19-06",
"popularity": 100,
"series_count": 18
},
{
"name": "usa",
"group_id": "geo",
"notes": "United States of America",
"created": "2012-02-27 10:18:19-06",
"popularity": 100,
"series_count": 18
},
{
"name": "weekly",
"group_id": "freq",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 82,
"series_count": 18
},
{
"name": "nsa",
"group_id": "seas",
"notes": "Not seasonally adjusted",
"created": "2012-02-27 10:18:19-06",
"popularity": 96,
"series_count": 9
},
{
"name": "sa",
"group_id": "seas",
"notes": "Seasonally adjusted",
"created": "2012-02-27 10:18:19-06",
"popularity": 94,
"series_count": 9
},
{
"name": "financial",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 70,
"series_count": 6
},
{
"name": "nonfinancial",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 63,
"series_count": 6
},
{
"name": "domestic",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 69,
"series_count": 4
},
{
"name": "foreign",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 58,
"series_count": 4
},
{
"name": "asset-backed",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 43,
"series_count": 2
},
{
"name": "companies",
"group_id": "gen",
"notes": "",
"created": "2012-02-27 10:18:19-06",
"popularity": 49,
"series_count": 1
}
]
}
Parameters
api_key
Read API Keys for more information.
- 32 character alpha-numeric lowercase string, required
file_type
A key or file extension that indicates the type of file to send.
- string, optional, default: xml
- One of the following values: 'xml', 'json'
xml = Extensible Markup Language. The HTTP Content-Type is text/xml.
json = JavaScript Object Notation. The HTTP Content-Type is application/json.
release_id
The id for a release.
- integer, required
realtime_start
The start of the real-time period. For more information, see Real-Time Periods.
- YYYY-MM-DD formatted string, optional, default: today's date
realtime_end
The end of the real-time period. For more information, see Real-Time Periods.
- YYYY-MM-DD formatted string, optional, default: today's date
tag_names
A semicolon delimited list of tag names to only include in the response. See the related request fred/release/related_tags.
- String, optional, no filtering by tag names by default
- Example value: 'gnp;quarterly'. This value filters results to only include tags 'gnp' and 'quarterly'.
tag_group_id
A tag group id to filter tags by type.
- String, optional, no filtering by tag group by default.
-
One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'.
freq = Frequency
gen = General or Concept
geo = Geography
geot = Geography Type
rls = Release
seas = Seasonal Adjustment
src = Source
search_text
The words to find matching tags with.
- String, optional, no filtering by search words by default.
limit
The maximum number of results to return.
- integer between 1 and 1000, optional, default: 1000
offset
- non-negative integer, optional, default: 0
order_by
Order results by values of the specified attribute.
- One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'.
- optional, default: series_count
sort_order
Sort results is ascending or descending order for attribute values specified by order_by.
- One of the following strings: 'asc', 'desc'.
- optional, default: asc