Skip to main content
API Keys | Terms of Use

fred/category/related_tags

Description

Get the related FRED tags for one or more FRED tags within a category. 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 category set by the category_id parameter. See the related request fred/category/tags.

Series are assigned tags and categories. Indirectly through series, it is possible to get the tags for a category. No tags exist for a category that does not have series.

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/category/related_tags?category_id=125&tag_names=services;quarterly&api_key=abcdefghijklmnopqrstuvwxyz123456

Response

<tags realtime_start="2013-08-13" realtime_end="2013-08-13" order_by="series_count" sort_order="desc" count="7" offset="0" limit="1000">
<tag name="balance" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="65" series_count="4"/>
<tag name="bea" group_id="src" notes="U.S. Department of Commerce: Bureau of Economic Analysis" created="2012-02-27 10:18:19-06" popularity="87" series_count="4"/>
<tag name="nation" group_id="geot" notes="Country Level" created="2012-02-27 10:18:19-06" popularity="100" series_count="4"/>
<tag name="usa" group_id="geo" notes="United States of America" created="2012-02-27 10:18:19-06" popularity="100" series_count="4"/>
<tag name="goods" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="73" series_count="2"/>
<tag name="nsa" group_id="seas" notes="Not seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="96" series_count="2"/>
<tag name="sa" group_id="seas" notes="Seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="94" series_count="2"/>
</tags>

JSON

Request (HTTPS GET)

https://api.stlouisfed.org/fred/category/related_tags?category_id=125&tag_names=services;quarterly&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json

Response

{
    "realtime_start": "2013-08-13",
    "realtime_end": "2013-08-13",
    "order_by": "series_count",
    "sort_order": "desc",
    "count": 7,
    "offset": 0,
    "limit": 1000,
    "tags": [
        {
            "name": "balance",
            "group_id": "gen",
            "notes": "",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 65,
            "series_count": 4
        },
        {
            "name": "bea",
            "group_id": "src",
            "notes": "U.S. Department of Commerce: Bureau of Economic Analysis",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 87,
            "series_count": 4
        },
        {
            "name": "nation",
            "group_id": "geot",
            "notes": "Country Level",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 100,
            "series_count": 4
        },
        {
            "name": "usa",
            "group_id": "geo",
            "notes": "United States of America",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 100,
            "series_count": 4
        },
        {
            "name": "goods",
            "group_id": "gen",
            "notes": "",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 73,
            "series_count": 2
        },
        {
            "name": "nsa",
            "group_id": "seas",
            "notes": "Not seasonally adjusted",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 96,
            "series_count": 2
        },
        {
            "name": "sa",
            "group_id": "seas",
            "notes": "Seasonally adjusted",
            "created": "2012-02-27 10:18:19-06",
            "popularity": 94,
            "series_count": 2
        }
    ]
}

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.

category_id

The id for a category.

  • 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 that series match all of. See the related request fred/category/tags.

  • String, required, no default value.
  • Example value: 'services;quarterly'. Find the related tags for series having both tags 'services' and 'quarterly'.

exclude_tag_names

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

  • String, optional, no default value.
  • Example value: 'goods;sa'. Find the related tags for series having neither tag 'goods' nor tag 'sa'.

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

Subscribe to our newsletter


Follow us

Twitter logo Google Plus logo Facebook logo YouTube logo LinkedIn logo
Back to Top