fred/release

• Description
• Examples
  • XML
  • JSON
• Parameters
  • api_key
  • file_type
  • release_id
  • realtime_start
  • realtime_end

Description

Get a release of economic data.

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?release_id=53&api_key=abcdefghijklmnopqrstuvwxyz123456

Response

<releases realtime_start="2013-08-13" realtime_end="2013-08-13">
    <release id="53" realtime_start="2013-08-13" realtime_end="2013-08-13" name="Gross Domestic Product" press_release="true" link="http://www.bea.gov/national/index.htm"/>
</releases>

The release tag's link and notes attributes are optional.

JSON

Request (HTTPS GET)

https://api.stlouisfed.org/fred/release?release_id=53&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json

Response

{
    "realtime_start": "2013-08-14",
    "realtime_end": "2013-08-14",
    "releases": [
        {
            "id": 53,
            "realtime_start": "2013-08-14",
            "realtime_end": "2013-08-14",
            "name": "Gross Domestic Product",
            "press_release": true,
            "link": "http://www.bea.gov/national/index.htm"
        }
    ]
}

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