---

Maps API - Series Group Info

Description

This request returns the meta information needed to make requests for FRED data. Minimum and maximum date are also supplied for the data range available.

Parameters

• api_key
• file_type
• series_id

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/geofred/series/group?series_id=SMU56000000500000001a&api_key=abcdefghijklmnopqrstuvwxyz123456

Response

                    <?xml version="1.0" encoding="utf-8" ?>
                    <series_meta>
                        <series_meta title="All Employees: Total Private" region_type="state" series_group="1223" season="NSA" units="Thousands of Persons" frequency="a" min_date="1990-01-01" max_date="2021-01-01"/>
                    </series_meta>
                

JSON

Request (HTTPS GET)

https://api.stlouisfed.org/geofred/series/group?series_id=SMU56000000500000001a&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json

Response

{
                    "series_group": {
                        "title" : "All Employees: Total Private",
                        "region_type" : "state",
                        "series_group" : "1223",
                        "season" : "NSA",
                        "units" : "Thousands of Persons",
                        "frequency" : "Annual",
                        "min_date" : "1990-01-01",
                        "max_date" : "2021-01-01"
                        }
                    }

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.

• 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.

series_id

The FRED series id you want to request maps meta information for. Not all series that are in FRED have geographical data.

• string, required