FRED API

https://fred.stlouisfed.org/docs/api/fred
Admin
The FRED API provides programmatic access to retrieve economic data from the Federal Reserve...
Tokens:27,069
Snippets:115
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### XML Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/related_tags.html

Example of an XML response when requesting related FRED tags.

```xml
<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="nation" group_id="geot" notes="Country Level" created="2012-02-27 10:18:19-06" popularity="100" series_count="12"/>
    <tag name="usa" group_id="geo" notes="United States of America" created="2012-02-27 10:18:19-06" popularity="100" series_count="12"/>
    <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="10"/>
    <tag name="nsa" group_id="seas" notes="Not seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="96" series_count="6"/>
    <tag name="sa" group_id="seas" notes="Seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="94" series_count="6"/>
    <tag name="m1" group_id="gen" notes="M1 Money Stock" created="2012-02-27 10:18:19-06" popularity="71" series_count="4"/>
    <tag name="m2" group_id="gen" notes="M2 Money Stock" created="2012-02-27 10:18:19-06" popularity="75" series_count="4"/>
    <tag name="currency" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="74" series_count="2"/>
    <tag name="discontinued" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="68" series_count="2"/>
    <tag name="frb stl" group_id="src" notes="Federal Reserve Bank of St. Louis (source)" created="2012-02-27 10:18:19-06" popularity="81" series_count="2"/>
    <tag name="h6" group_id="rls" notes="H.6 Money Stock Measures" created="2012-08-16 15:21:17-05" popularity="41" series_count="2"/>
    <tag name="m3" group_id="gen" notes="M3 Money Stock" created="2012-02-27 10:18:19-06" popularity="50" series_count="2"/>
    <tag name="mzm" group_id="gen" notes="MZM Money Stock" created="2012-02-27 10:18:19-06" popularity="61" series_count="2"/>
</tags>
```

--------------------------------

### GET /fred/release/tables

Source: https://fred.stlouisfed.org/docs/api/fred/release_tables.html

Retrieves release table trees for a given release. You can specify an element_id to get a specific part of the tree or omit it to start from the root.

```APIDOC
## GET /fred/release/tables

### Description
Get release table trees for a given release. You can go directly to the tree structure by passing the appropriate element_id. You may also use a drill-down approach to start at the root (top most) element by leaving the element_id off. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

### Method
GET

### Endpoint
https://api.stlouisfed.org/fred/release/tables

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your FRED API key.
- **file_type** (string) - Optional - The type of file to return. Options are 'xml' (default) or 'json'.
- **release_id** (integer) - Required - The ID of the release.
- **element_id** (integer) - Optional - The ID of the element to retrieve the tree for. If omitted, the root element is returned.
- **include_observation_values** (boolean) - Optional - Whether to include observation values. Defaults to false.
- **observation_date** (date) - Optional - The observation date to filter by.

### Request Example
#### JSON Request
```json
https://api.stlouisfed.org/fred/release/tables?release_id=53&api_key=abcdefghijklmnopqrstuvwxyz123456&element_id=12886&file_type=json
```

### Response
#### Success Response (200)
- **elements** (object) - Contains the release table tree structure.
  - **name** (string) - The name of the element.
  - **element_id** (integer) - The ID of the element.
  - **release_id** (integer) - The ID of the release.
  - **element** (array) - An array of child elements.
    - **element_id** (integer) - The ID of the child element.
    - **release_id** (integer) - The ID of the release.
    - **series_id** (string) - The series ID associated with the element, if any.
    - **parent_id** (integer) - The ID of the parent element.
    - **line** (integer) - The line number of the element.
    - **type** (string) - The type of the element (e.g., 'series').
    - **name** (string) - The name of the child element.
    - **level** (integer) - The level of the element in the tree.
    - **children** (array) - An array of further nested child elements.

#### Response Example
```json
{
  "elements": {
    "name": "Personal consumption expenditures",
    "element_id": 12886,
    "release_id": 53,
    "element": [
      {
        "element_id": 12887,
        "release_id": 53,
        "series_id": "DGDSRL1A225NBEA",
        "parent_id": 12886,
        "line": 3,
        "type": "series",
        "name": "Goods",
        "level": 1,
        "children": [
          {
            "element_id": 12888,
            "release_id": 53,
            "series_id": "DDURRL1A225NBEA",
            "parent_id": 12887,
            "line": 4,
            "type": "series",
            "name": "Durable goods",
            "level": 2,
            "children": []
          },
          {
            "element_id": 12889,
            "release_id": 53,
            "series_id": "DNDGRL1A225NBEA",
            "parent_id": 12887,
            "line": 5,
            "type": "series",
            "name": "Nondurable goods",
            "level": 2,
            "children": []
          }
        ]
      },
      {
        "element_id": 12890,
        "release_id": 53,
        "series_id": "DSERRL1A225NBEA",
        "parent_id": 12886,
        "line": 6,
        "type": "series",
        "name": "Services",
        "level": 1,
        "children": []
      }
    ]
  }
}
```
```

--------------------------------

### XML Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/category_related_tags.html

Example of an XML response when requesting related FRED tags. The response includes tag details such as name, group_id, and series_count.

```xml
<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>
```

--------------------------------

### XML Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/release_tags.html

Sample XML output returned by the fred/release/tags endpoint.

```xml
<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>
```

--------------------------------

### XML Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/category_tags.html

The default response format for the category tags request.

```xml
<tags realtime_start="2013-08-13" realtime_end="2013-08-13" order_by="series_count" sort_order="desc" count="21" offset="0" limit="1000">
    <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="24"/>
    <tag name="nation" group_id="geot" notes="Country Level" created="2012-02-27 10:18:19-06" popularity="100" series_count="24"/>
    <tag name="usa" group_id="geo" notes="United States of America" created="2012-02-27 10:18:19-06" popularity="100" series_count="24"/>
    <tag name="balance" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="65" 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="14"/>
    <tag name="quarterly" group_id="freq" notes="" created="2012-02-27 10:18:19-06" popularity="88" series_count="14"/>
    <tag name="sa" group_id="seas" notes="Seasonally adjusted" created="2012-02-27 10:18:19-06" popularity="94" series_count="10"/>
    <tag name="bop" group_id="gen" notes="Balance of Payments" created="2013-01-28 14:10:13-06" popularity="60" series_count="8"/>
    <tag name="services" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="72" series_count="8"/>
    <tag name="annual" group_id="freq" notes="" created="2012-02-27 10:18:19-06" popularity="83" series_count="7"/>
    <tag name="net" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="68" series_count="6"/>
    <tag name="trade" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="60" series_count="6"/>
    <tag name="goods" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="73" series_count="5"/>
    <tag name="capital account" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="42" series_count="3"/>
    <tag name="census" group_id="src" notes="U.S. Department of Commerce: Census Bureau" created="2012-02-27 10:18:19-06" popularity="78" series_count="3"/>
    <tag name="current account" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="55" series_count="3"/>
    <tag name="income" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="61" series_count="3"/>
    <tag name="investment" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="67" series_count="3"/>
    <tag name="monthly" group_id="freq" notes="" created="2012-02-27 10:18:19-06" popularity="95" series_count="3"/>
    <tag name="transfers" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="50" series_count="3"/>
    <tag name="payments" group_id="gen" notes="" created="2012-02-27 10:18:19-06" popularity="57" series_count="1"/>
</tags>
```

--------------------------------

### XML Error Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/errors.html

Example of an XML-formatted error response returned by the API when a request is invalid.

```text
https://api.stlouisfed.org/fred/series/updates
```

```xml
HTTP/1.x 400 Bad Request
Content-Type: text/xml;charset=utf-8
...

<error code="400" message="Bad Request.  Variable api_key has not been set."/>
```

--------------------------------

### GET /fred/release/sources

Source: https://fred.stlouisfed.org/docs/api/fred/release_sources.html

Retrieves the sources for a specific release of economic data.

```APIDOC
## GET /fred/release/sources

### Description
Get the sources for a release of economic data.

### Method
GET

### Endpoint
https://api.stlouisfed.org/fred/release/sources

### Parameters
#### Query Parameters
- **api_key** (string) - Required - 32 character alpha-numeric lowercase string.
- **file_type** (string) - Optional - A key or file extension that indicates the type of file to send (xml or json). Default: xml.
- **release_id** (integer) - Required - The id for a release.
- **realtime_start** (string) - Optional - The start of the real-time period (YYYY-MM-DD). Default: today's date.
- **realtime_end** (string) - Optional - The end of the real-time period (YYYY-MM-DD). Default: today's date.

### Request Example
https://api.stlouisfed.org/fred/release/sources?release_id=51&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json

### Response
#### Success Response (200)
- **realtime_start** (string) - The start of the real-time period.
- **realtime_end** (string) - The end of the real-time period.
- **sources** (array) - List of source objects containing id, name, and link.

#### Response Example
{
    "realtime_start": "2013-08-14",
    "realtime_end": "2013-08-14",
    "sources": [
        {
            "id": 18,
            "realtime_start": "2013-08-14",
            "realtime_end": "2013-08-14",
            "name": "U.S. Department of Commerce: Bureau of Economic Analysis",
            "link": "http://www.bea.gov/"
        }
    ]
}
```

--------------------------------

### Release Sources Response (XML)

Source: https://fred.stlouisfed.org/docs/api/fred/release_sources.html

Example XML response showing source details including ID, name, and optional link for a release.

```xml
<sources realtime_start="2013-08-13" realtime_end="2013-08-13">
    <source id="18" realtime_start="2013-08-13" realtime_end="2013-08-13" name="U.S. Department of Commerce: Bureau of Economic Analysis" link="http://www.bea.gov/"/>
    <source id="19" realtime_start="2013-08-13" realtime_end="2013-08-13" name="U.S. Department of Commerce: Census Bureau" link="http://www.census.gov/"/>
</sources>
```

--------------------------------

### Release Sources Response (JSON)

Source: https://fred.stlouisfed.org/docs/api/fred/release_sources.html

Example JSON response containing source information for a release, including ID, name, and optional link.

```json
{
    "realtime_start": "2013-08-14",
    "realtime_end": "2013-08-14",
    "sources": [
        {
            "id": 18,
            "realtime_start": "2013-08-14",
            "realtime_end": "2013-08-14",
            "name": "U.S. Department of Commerce: Bureau of Economic Analysis",
            "link": "http://www.bea.gov/"
        },
        {
            "id": 19,
            "realtime_start": "2013-08-14",
            "realtime_end": "2013-08-14",
            "name": "U.S. Department of Commerce: Census Bureau",
            "link": "http://www.census.gov/"
        }
    ]
}
```

--------------------------------

### Get Series for a Release (XML)

Source: https://fred.stlouisfed.org/docs/api/fred/release_series.html

Use this HTTPS GET request to retrieve economic data series for a given release ID. Ensure you replace the placeholder API key with your registered key. The default response format is XML.

```http
https://api.stlouisfed.org/fred/release/series?release_id=51&api_key=abcdefghijklmnopqrstuvwxyz123456
```

--------------------------------

### JSON Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/category_related_tags.html

Example of a JSON response when requesting related FRED tags. The response structure is an object containing tag information, suitable for programmatic parsing.

```json
{
    "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
        }
    ]
}
```

--------------------------------

### JSON Error Response Example

Source: https://fred.stlouisfed.org/docs/api/fred/errors.html

Example of a JSON-formatted error response returned by the API when a request is invalid.

```text
https://api.stlouisfed.org/fred/series/updates?file_type=json
```

```json
HTTP/1.x 400 Bad Request
Content-Type: text/xml;charset=utf-8
...

{
    "error_code": 400,
    "error_message": "Bad Request.  The value for variable api_key is not registered.  Read https://fred.stlouisfed.org/docs/api/api_key.html for more information."
}
```

--------------------------------

### GET /fred/release/series

Source: https://fred.stlouisfed.org/docs/api/fred/release_series.html

Retrieves the series associated with a specific release.

```APIDOC
## GET /fred/release/series

### Description
Retrieves the series associated with a specific release.

### Method
GET

### Endpoint
https://api.stlouisfed.org/fred/release/series

### Parameters
#### Query Parameters
- **release_id** (string) - Required - The ID of the release.
- **api_key** (string) - Required - Your FRED API key.
- **file_type** (string) - Optional - The format of the response (e.g., json).

### Request Example
https://api.stlouisfed.org/fred/release/series?release_id=51&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
```

--------------------------------

### GET /tags

Source: https://fred.stlouisfed.org/docs/api/fred/related_tags.html

Retrieves a list of tags based on optional filtering parameters.

```APIDOC
## GET /tags

### Description
Retrieves tags from the FRED database, allowing for filtering by tag group, search text, and pagination.

### Method
GET

### Endpoint
/tags

### Parameters
#### Query Parameters
- **tag_group_id** (string) - Optional - Filter tags by type: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'.
- **search_text** (string) - Optional - Words to find matching tags.
- **limit** (integer) - Optional - Maximum results (1-1000, default: 1000).
- **offset** (integer) - Optional - Non-negative integer (default: 0).
- **order_by** (string) - Optional - Attribute to order by: 'series_count', 'popularity', 'created', 'name', 'group_id' (default: series_count).
- **sort_order** (string) - Optional - Sort direction: 'asc', 'desc' (default: asc).
```

--------------------------------

### Get Release Sources (JSON)

Source: https://fred.stlouisfed.org/docs/api/fred/release_sources.html

Retrieve sources for a specific release ID in JSON format by setting the file_type parameter. An API key is required.

```http
https://api.stlouisfed.org/fred/release/sources?release_id=51&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
```

--------------------------------

### GET /fred/release

Source: https://fred.stlouisfed.org/docs/api/fred/release.html

Retrieves a specific release of economic data. The response format can be specified as XML or JSON.

```APIDOC
## GET /fred/release

### Description
Get a release of economic data.

### Method
GET

### Endpoint
https://api.stlouisfed.org/fred/release

### Parameters
#### Query Parameters
- **api_key** (string) - Required - 32 character alpha-numeric lowercase string.
- **file_type** (string) - Optional - Defaults to 'xml'. Can be 'xml' or 'json'.
- **release_id** (integer) - Required - The id for a release.
- **realtime_start** (string) - Optional - YYYY-MM-DD formatted string. Defaults to today's date.
- **realtime_end** (string) - Optional - YYYY-MM-DD formatted string. Defaults to today's date.

### Request Example
```json
{
  "example": "https://api.stlouisfed.org/fred/release?release_id=53&api_key=abcdefghijklmnopqrstuvwxyz123456"
}
```

### Response
#### Success Response (200)
- **realtime_start** (string) - The start of the real-time period.
- **realtime_end** (string) - The end of the real-time period.
- **releases** (array) - An array of release objects.
  - **id** (integer) - The ID of the release.
  - **realtime_start** (string) - The start of the real-time period for the release.
  - **realtime_end** (string) - The end of the real-time period for the release.
  - **name** (string) - The name of the release.
  - **press_release** (boolean) - Indicates if a press release is available.
  - **link** (string) - A URL to the release information.

#### Response Example (JSON)
```json
{
    "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"
        }
    ]
}
```

#### Response Example (XML)
```xml
<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>
```
```

--------------------------------

### Retrieve Related Tags in XML

Source: https://fred.stlouisfed.org/docs/api/fred/release_related_tags.html

Request and response example for fetching related tags in XML format. XML is the default file type.

```http
https://api.stlouisfed.org/fred/release/related_tags?release_id=86&tag_names=sa;foreign&api_key=abcdefghijklmnopqrstuvwxyz123456
```

```xml
<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>
```

--------------------------------

### Retrieve Economic Data Release in JSON

Source: https://fred.stlouisfed.org/docs/api/fred/release.html

Request an economic data release using the HTTPS GET method with JSON format.

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

```json
{
    "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"
        }
    ]
}
```

--------------------------------

### Retrieve Economic Data Release in XML

Source: https://fred.stlouisfed.org/docs/api/fred/release.html

Request an economic data release using the HTTPS GET method with XML format.

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

```xml
<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>
```

--------------------------------

### GET /fred/release/tables

Source: https://fred.stlouisfed.org/docs/api/fred/release_tables.html

Retrieves economic data tables for a specified release. You can filter by release ID, element ID, and include observation values.

```APIDOC
## GET /fred/release/tables

### Description
Retrieves economic data tables for a specified release. You can filter by release ID, element ID, and include observation values.

### Method
GET

### Endpoint
/fred/release/tables

### Parameters
#### Query Parameters
- **api_key** (string) - Required - 32 character alpha-numeric lowercase string.
- **release_id** (integer) - Required - The id for a release.
- **file_type** (string) - Optional - A key or file extension that indicates the type of file to send. Defaults to 'xml'. Allowed values: 'xml', 'json'.
- **element_id** (integer) - Optional - The release table element id you would like to retrieve. If not passed, the root element for the release is given.
- **include_observation_values** (string) - Optional - A flag to indicate that observations need to be returned. Observation value and date will only be returned for a series type element. Allowed values: 'true', 'false'. Defaults to 'false'.
- **observation_date** (string) - Optional - The observation date to be included with the returned release table. Format: YYYY-MM-DD. Defaults to the latest available date.

### Response
#### Success Response (200)
- **name** (string) - The name of the economic indicator.
- **element_id** (integer) - The ID of the element.
- **release_id** (string) - The ID of the release.
- **elements** (object) - A nested object containing detailed information about the elements within the release table.
  - **element_id** (integer) - The ID of the sub-element.
  - **release_id** (integer) - The ID of the release for the sub-element.
  - **series_id** (string) - The unique identifier for the data series.
  - **parent_id** (integer) - The ID of the parent element.
  - **line** (string) - The line number in the table.
  - **type** (string) - The type of the element (e.g., 'series').
  - **name** (string) - The name of the sub-element.
  - **level** (string) - The hierarchical level of the element.
  - **children** (array) - An array of child elements.

#### Response Example
```json
{
  "name": "Personal consumption expenditures",
  "element_id": 12886,
  "release_id": "53",
  "elements": {
    "12887": {
      "element_id": 12887,
      "release_id": 53,
      "series_id": "DGDSRL1A225NBEA",
      "parent_id": 12886,
      "line": "3",
      "type": "series",
      "name": "Goods",
      "level": "1",
      "children": [
        {
          "element_id": 12888,
          "release_id": 53,
          "series_id": "DDURRL1A225NBEA",
          "parent_id": 12887,
          "line": "4",
          "type": "series",
          "name": "Durable goods",
          "level": "2",
          "children": []
        },
        {
          "element_id": 12889,
          "release_id": 53,
          "series_id": "DNDGRL1A225NBEA",
          "parent_id": 12887,
          "line": "5",
          "type": "series",
          "name": "Nondurable goods",
          "level": "2",
          "children": []
        }
      ]
    },
    "12888": {
      "element_id": 12888,
      "release_id": 53,
      "series_id": "DDURRL1A225NBEA",
      "parent_id": 12887,
      "line": "4",
      "type": "series",
      "name": "Durable goods",
      "level": "2",
      "children": []
    },
    "12889": {
      "element_id": 12889,
      "release_id": 53,
      "series_id": "DNDGRL1A225NBEA",
      "parent_id": 12887,
      "line": "5",
      "type": "series",
      "name": "Nondurable goods",
      "level": "2",
      "children": []
    },
    "12890": {
      "element_id": 12890,
      "release_id": 53,
      "series_id": "DSERRL1A225NBEA",
      "parent_id": 12886,
      "line": "6",
      "type": "series",
      "name": "Services",
      "level": "1",
      "children": []
    }
  }
}
```
```

--------------------------------

### Retrieve Related Tags in JSON

Source: https://fred.stlouisfed.org/docs/api/fred/release_related_tags.html

Request and response example for fetching related tags in JSON format by setting the file_type parameter.

```http
https://api.stlouisfed.org/fred/release/related_tags?release_id=86&tag_names=sa;foreign&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
```

```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
        }
    ]
}
```

--------------------------------

### GET /series

Source: https://fred.stlouisfed.org/docs/api/fred/release_series.html

Retrieves metadata for economic series, including details like title, frequency, units, and observation ranges.

```APIDOC
## GET /series

### Description
Retrieves metadata for a specific economic series based on its unique identifier.

### Method
GET

### Endpoint
/series

### Parameters
#### Query Parameters
- **series_id** (string) - Required - The unique identifier for the economic series (e.g., IMPJP, IMPKR, ITMCIPM133S).

### Response
#### Success Response (200)
- **id** (string) - The series identifier.
- **realtime_start** (string) - The start date of the real-time period.
- **realtime_end** (string) - The end date of the real-time period.
- **title** (string) - The title of the series.
- **observation_start** (string) - The start date of the observations.
- **observation_end** (string) - The end date of the observations.
- **frequency** (string) - The frequency of the data (e.g., Monthly).
- **units** (string) - The units of measurement.
- **seasonal_adjustment** (string) - The seasonal adjustment status.
- **last_updated** (string) - The timestamp of the last update.
- **popularity** (integer) - The popularity score of the series.

#### Response Example
{
  "id": "IMPJP",
  "title": "U.S. Imports of Goods from Japan, Customs Basis",
  "frequency": "Monthly",
  "units": "Millions of Dollars",
  "seasonal_adjustment": "Not Seasonally Adjusted"
}
```

--------------------------------

### GET /fred/release/dates

Source: https://fred.stlouisfed.org/docs/api/fred/release_dates.html

Retrieves release dates for a specified economic data release. You can specify the output format (XML or JSON) and filter by date ranges.

```APIDOC
## GET /fred/release/dates

### Description
Get release dates for a release of economic data. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

### Method
GET

### Endpoint
https://api.stlouisfed.org/fred/release/dates

### Parameters
#### Query Parameters
- **api_key** (string) - Required - 32 character alpha-numeric lowercase string.
- **release_id** (integer) - Required - The id for a release.
- **file_type** (string) - Optional, default: xml - A key or file extension that indicates the type of file to send. One of the following values: 'xml', 'json'.
- **realtime_start** (string) - Optional, default: 1776-07-04 - The start of the real-time period (YYYY-MM-DD).
- **realtime_end** (string) - Optional, default: 9999-12-31 - The end of the real-time period (YYYY-MM-DD).
- **limit** (integer) - Optional, default: 10000 - The maximum number of results to return (between 1 and 10000).
- **offset** (integer) - Optional - The starting offset of the results to return.
- **sort_order** (string) - Optional - The order to sort the results by. Values: 'asc', 'desc'.
- **include_release_dates_with_no_data** (boolean) - Optional - Whether to include release dates with no data. Values: 'true', 'false'.

### Request Example (JSON)
```
https://api.stlouisfed.org/fred/release/dates?release_id=82&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
```

### Response
#### Success Response (200)
- **realtime_start** (string) - The start of the real-time period.
- **realtime_end** (string) - The end of the real-time period.
- **order_by** (string) - The field by which results are ordered.
- **sort_order** (string) - The order of the results.
- **count** (integer) - The number of results returned.
- **offset** (integer) - The starting offset of the results.
- **limit** (integer) - The maximum number of results.
- **release_dates** (array) - An array of release date objects.
  - **release_id** (integer) - The ID of the release.
  - **date** (string) - The release date in YYYY-MM-DD format.

#### Response Example (JSON)
```json
{
    "realtime_start": "1776-07-04",
    "realtime_end": "9999-12-31",
    "order_by": "release_date",
    "sort_order": "asc",
    "count": 17,
    "offset": 0,
    "limit": 10000,
    "release_dates": [
        {
            "release_id": 82,
            "date": "1997-02-10"
        },
        {
            "release_id": 82,
            "date": "1998-02-10"
        }
    ]
}
```
```

--------------------------------

### Retrieve Category Series via HTTPS GET

Source: https://fred.stlouisfed.org/docs/api/fred/category_series.html

Example request to fetch series associated with a specific category ID using JSON format.

```http
https://api.stlouisfed.org/fred/category/series?category_id=125&api_key=abcdefghijklmnopqrstuvwxyz123456&file_type=json
```

--------------------------------

### Get Release Sources (XML)

Source: https://fred.stlouisfed.org/docs/api/fred/release_sources.html

Use this endpoint to retrieve sources for a given release ID in XML format. Ensure you replace the placeholder API key with your registered key.

```http
https://api.stlouisfed.org/fred/release/sources?release_id=51&api_key=abcdefghijklmnopqrstuvwxyz123456
```
Tokens:
Raw