> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/fred.md).

# Fred

FRED (Federal Reserve Economic Data) provides US economic time series. Connect to look up categories, releases, series, sources, and tags of economic data from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Fred      | API Key        |

#### Fred

Connect to Fred to access economic data from the Federal Reserve Bank

**Set up in Fred**

1. Create a free FRED account at <https://fredaccount.stlouisfed.org/login/secure/> and verify your email.
2. Go to <https://fredaccount.stlouisfed.org/apikeys> and request an API key (approval is typically immediate and free).
3. Copy your 32-character API key.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Fred**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                   |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Find or create your API key at <https://fredaccount.stlouisfed.org/apikey>. [Provider instructions](https://fredaccount.stlouisfed.org/apikey). |

**Provider documentation:** [Setup reference](https://fred.stlouisfed.org/docs/api/api_key.html).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Fred** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get A Category.

Use this tool to get get a category.

**Inputs**

| Field       | Type    | Required | Description   |
| ----------- | ------- | -------- | ------------- |
| Api Key     | string  | Yes      |               |
| File Type   | string  | No       | Default: xml. |
| Category Id | integer | No       | Default: 0.   |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get The Child Categories For A Specified Parent Category.

Use this tool to get get the child categories for a specified parent category.

**Inputs**

| Field          | Type    | Required | Description   |
| -------------- | ------- | -------- | ------------- |
| Api Key        | string  | Yes      |               |
| File Type      | string  | No       | Default: xml. |
| Category Id    | integer | No       | Default: 0.   |
| Realtime Start | string  | No       |               |
| Realtime End   | string  | No       |               |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Related Categories For A Specified Category.

Use this tool to get get related categories for a specified category.

**Inputs**

| Field          | Type    | Required | Description   |
| -------------- | ------- | -------- | ------------- |
| Api Key        | string  | Yes      |               |
| File Type      | string  | No       | Default: xml. |
| Category Id    | integer | No       | Default: 0.   |
| Realtime Start | string  | No       |               |
| Realtime End   | string  | No       |               |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Retrieve Series Within A Specified Category.

Use this tool to get retrieve series within a specified category.

**Inputs**

| Field           | Type    | Required | Description                          |
| --------------- | ------- | -------- | ------------------------------------ |
| Api Key         | string  | Yes      |                                      |
| File Type       | string  | No       | Default: xml.                        |
| Category Id     | integer | Yes      |                                      |
| Realtime Start  | string  | No       |                                      |
| Realtime End    | string  | No       |                                      |
| Limit           | integer | No       | Maximum number of results to return. |
| Offset          | integer | No       | Offset for the start of the results. |
| Order By        | string  | No       |                                      |
| Sort Order      | string  | No       |                                      |
| Filter Variable | string  | No       |                                      |
| Filter Value    | string  | No       |                                      |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Retrieve Tags For A Specific Category.

Use this tool to get retrieve tags for a specific category.

**Inputs**

| Field          | Type    | Required | Description                          |
| -------------- | ------- | -------- | ------------------------------------ |
| Api Key        | string  | Yes      |                                      |
| File Type      | string  | No       | Default: xml.                        |
| Category Id    | integer | Yes      |                                      |
| Realtime Start | string  | No       |                                      |
| Realtime End   | string  | No       |                                      |
| Limit          | integer | No       | Maximum number of results to return. |
| Offset         | integer | No       | Offset for the start of the results. |
| Order By       | string  | No       |                                      |
| Sort Order     | string  | No       |                                      |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Retrieve Related Tags For A Specific Category.

Use this tool to get retrieve related tags for a specific category.

**Inputs**

| Field          | Type    | Required | Description                             |
| -------------- | ------- | -------- | --------------------------------------- |
| Api Key        | string  | Yes      |                                         |
| File Type      | string  | No       | Default: xml.                           |
| Category Id    | integer | Yes      |                                         |
| Tag Names      | string  | Yes      | Names of tags to find related tags for. |
| Realtime Start | string  | No       |                                         |
| Realtime End   | string  | No       |                                         |
| Limit          | integer | No       | Maximum number of results to return.    |
| Offset         | integer | No       | Offset for the start of the results.    |
| Order By       | string  | No       |                                         |
| Sort Order     | string  | No       |                                         |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get All Releases Of Economic Data.

Use this tool to get get all releases of economic data.

**Inputs**

| Field           | Type    | Required | Description                              |
| --------------- | ------- | -------- | ---------------------------------------- |
| Api Key         | string  | Yes      |                                          |
| File Type       | string  | No       | Default: json.                           |
| Realtime Start  | string  | No       |                                          |
| Realtime End    | string  | No       |                                          |
| Limit           | integer | No       | The maximum number of results to return. |
| Offset          | integer | No       | The offset for the start of results.     |
| Order By        | string  | No       |                                          |
| Sort Order      | string  | No       |                                          |
| Filter Variable | string  | No       |                                          |
| Filter Value    | string  | No       |                                          |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Retrieve Release Dates For A Specific Economic Data Release.

Use this tool to get retrieve release dates for a specific economic data release.

**Inputs**

| Field          | Type    | Required | Description                                                 |
| -------------- | ------- | -------- | ----------------------------------------------------------- |
| Api Key        | string  | Yes      |                                                             |
| File Type      | string  | No       | Default: json.                                              |
| Release Id     | integer | Yes      | The unique ID of the release whose dates are being queried. |
| Realtime Start | string  | No       |                                                             |
| Realtime End   | string  | No       |                                                             |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Information For A Specific Economic Data Release.

Use this tool to get get information for a specific economic data release.

**Inputs**

| Field          | Type    | Required | Description                                |
| -------------- | ------- | -------- | ------------------------------------------ |
| Api Key        | string  | Yes      |                                            |
| File Type      | string  | No       | Default: json.                             |
| Release Id     | integer | Yes      | The unique ID for the release of interest. |
| Realtime Start | string  | No       |                                            |
| Realtime End   | string  | No       |                                            |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Series For A Specific Economic Data Release.

Use this tool to get get series for a specific economic data release.

**Inputs**

| Field           | Type    | Required | Description                                                  |
| --------------- | ------- | -------- | ------------------------------------------------------------ |
| Api Key         | string  | Yes      |                                                              |
| Release Id      | integer | Yes      | The unique ID of the release whose series are being queried. |
| File Type       | string  | No       | Default: json.                                               |
| Realtime Start  | string  | No       |                                                              |
| Realtime End    | string  | No       |                                                              |
| Limit           | integer | No       | The maximum number of results to return.                     |
| Offset          | integer | No       | The offset for the start of results.                         |
| Order By        | string  | No       |                                                              |
| Sort Order      | string  | No       |                                                              |
| Filter Variable | string  | No       |                                                              |
| Filter Value    | string  | No       |                                                              |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Sources For A Specific Economic Data Release.

Use this tool to get get sources for a specific economic data release.

**Inputs**

| Field          | Type    | Required | Description                                                   |
| -------------- | ------- | -------- | ------------------------------------------------------------- |
| Api Key        | string  | Yes      |                                                               |
| Release Id     | integer | Yes      | The unique ID of the release whose sources are being queried. |
| File Type      | string  | No       | Default: json.                                                |
| Realtime Start | string  | No       |                                                               |
| Realtime End   | string  | No       |                                                               |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Tags For A Specific Economic Data Release.

Use this tool to get get tags for a specific economic data release.

**Inputs**

| Field          | Type    | Required | Description                                                |
| -------------- | ------- | -------- | ---------------------------------------------------------- |
| Api Key        | string  | Yes      |                                                            |
| Release Id     | integer | Yes      | The unique ID of the release whose tags are being queried. |
| File Type      | string  | No       | Default: json.                                             |
| Realtime Start | string  | No       |                                                            |
| Realtime End   | string  | No       |                                                            |
| Limit          | integer | No       | The maximum number of results to return.                   |
| Offset         | integer | No       | The offset for the start of results.                       |
| Order By       | string  | No       |                                                            |
| Sort Order     | string  | No       |                                                            |
| Search Text    | string  | No       | A keyword or phrase to search for within the tag names.    |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Retrieve Related Tags For A Specific Economic Data Release.

Use this tool to get retrieve related tags for a specific economic data release.

**Inputs**

| Field          | Type    | Required | Description                                                            |
| -------------- | ------- | -------- | ---------------------------------------------------------------------- |
| Api Key        | string  | Yes      |                                                                        |
| Release Id     | integer | Yes      | The unique ID of the release for which related tags are being queried. |
| File Type      | string  | No       | Default: json.                                                         |
| Tag Names      | string  | Yes      | Names of tags to find related tags for.                                |
| Realtime Start | string  | No       |                                                                        |
| Realtime End   | string  | No       |                                                                        |
| Limit          | integer | No       | The maximum number of results to return.                               |
| Offset         | integer | No       | The offset for the start of results.                                   |
| Order By       | string  | No       |                                                                        |
| Sort Order     | string  | No       |                                                                        |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Data Tables For A Specific Economic Data Release.

Use this tool to get get data tables for a specific economic data release.

**Inputs**

| Field                | Type    | Required | Description                                                      |
| -------------------- | ------- | -------- | ---------------------------------------------------------------- |
| Api Key              | string  | Yes      |                                                                  |
| Release Id           | integer | Yes      | The unique ID of the release for which tables are being queried. |
| File Type            | string  | No       | Default: json.                                                   |
| Element Id           | integer | No       | The unique ID of the element for which tables are being queried. |
| Include Observations | boolean | No       | Boolean to include observations in the table.                    |
| Observation Date     | string  | No       | The date of the observation to include in the table.             |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get An Economic Data Series.

Use this tool to get get an economic data series.

**Inputs**

| Field          | Type   | Required | Description                                                                     |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Api Key        | string | Yes      | Read API Keys for more information.                                             |
| File Type      | string | No       | A key or file extension that indicates the type of file to send. Default: json. |
| Series Id      | string | Yes      | The id for a series.                                                            |
| Realtime Start | string | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string | No       | The end of the real-time period. For more information, see Real-Time Periods.   |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Categories For An Economic Data Series.

Use this tool to get get categories for an economic data series.

**Inputs**

| Field          | Type   | Required | Description                                                                     |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Api Key        | string | Yes      | Read API Keys for more information.                                             |
| File Type      | string | No       | A key or file extension that indicates the type of file to send. Default: json. |
| Series Id      | string | Yes      | The id for a series.                                                            |
| Realtime Start | string | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string | No       | The end of the real-time period. For more information, see Real-Time Periods.   |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get The Observations Or Data Values For An Economic Data Series.

Use this tool to get get the observations or data values for an economic data series.

**Inputs**

| Field              | Type    | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Api Key            | string  | Yes      | Read API Keys for more information.                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| File Type          | string  | No       | A key or file extension that indicates the type of file to send. Default: json.                                                                                                                                                                                                                                                                                                                                                                                          |
| Series Id          | string  | Yes      | The id for a series.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Realtime Start     | string  | No       | The start of the real-time period. For more information, see Real-Time Periods.                                                                                                                                                                                                                                                                                                                                                                                          |
| Realtime End       | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.                                                                                                                                                                                                                                                                                                                                                                                            |
| Limit              | integer | No       | The maximum number of results to return.                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Offset             | integer | No       | non-negative integer, optional, default: 0. Default: 0.                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Sort Order         | string  | No       | Sort results is ascending or descending observation\_date order.                                                                                                                                                                                                                                                                                                                                                                                                         |
| Observation Start  | string  | No       | The start of the observation period.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Observation End    | string  | No       | The end of the observation period.                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Units              | string  | No       | A key that indicates a data value transformation.                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Frequency          | string  | No       | An optional parameter that indicates a lower frequency to aggregate values to. The FRED frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). In FRED, the highest frequency data is daily, and the lowest frequency data is annual. There are 3 aggregation methods available- average, sum, and end of period. See the aggregation\_method parameter. |
| Aggregation Method | string  | No       | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set.                                                                                                                                                                                                                                                                                                                          |
| Output Type        | integer | No       | An integer that indicates an output type.                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Vintage Dates      | string  | No       | Vintage dates are used to download data as it existed on these specified dates in history. Vintage dates can be specified instead of a real-time period using realtime\_start and realtime\_end.                                                                                                                                                                                                                                                                         |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get The Release For An Economic Data Series.

Use this tool to get get the release for an economic data series.

**Inputs**

| Field          | Type   | Required | Description                                                                     |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Api Key        | string | Yes      | Read API Keys for more information.                                             |
| File Type      | string | No       | A key or file extension that indicates the type of file to send. Default: json. |
| Series Id      | string | Yes      | The id for a series.                                                            |
| Realtime Start | string | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string | No       | The end of the real-time period. For more information, see Real-Time Periods.   |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Search For Economic Data Series.

Use this tool to get search for economic data series.

**Inputs**

| Field             | Type    | Required | Description                                                                     |
| ----------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Api Key           | string  | Yes      | Read API Keys for more information.                                             |
| File Type         | string  | No       | A key or file extension that indicates the type of file to send. Default: json. |
| Search Text       | string  | Yes      | The words to match against economic data series.                                |
| Search Type       | string  | No       | Determines the type of search to perform.                                       |
| Realtime Start    | string  | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End      | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.   |
| Limit             | integer | No       | The maximum number of results to return.                                        |
| Offset            | integer | No       | non-negative integer, optional, default: 0. Default: 0.                         |
| Order By          | string  | No       | Order results by values of the specified attribute.                             |
| Sort Order        | string  | No       | Sort results is ascending or descending observation\_date order.                |
| Filter Variable   | string  | No       | The attribute to filter results by.                                             |
| Filter Value      | string  | No       | The value of the filter\_variable attribute to filter results by.               |
| Tag Names         | string  | No       | A semicolon delimited list of tag names that series match all of.               |
| Exclude Tag Names | string  | No       | A semicolon delimited list of tag names that series match none of.              |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Tags For Series Search Results.

Use this tool to get get tags for series search results.

**Inputs**

| Field              | Type    | Required | Description                                                                     |
| ------------------ | ------- | -------- | ------------------------------------------------------------------------------- |
| Api Key            | string  | Yes      | Read API Keys for more information.                                             |
| File Type          | string  | No       | A key or file extension that indicates the type of file to send. Default: json. |
| Series Search Text | string  | Yes      | The words to match against economic data series.                                |
| Realtime Start     | string  | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End       | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.   |
| Tag Names          | string  | No       | A semicolon delimited list of tag names that series match all of.               |
| Tag Group Id       | string  | No       | A tag group id to filter tags by type.                                          |
| Tag Search Text    | string  | No       | The words to find matching tags with.                                           |
| Limit              | integer | No       | The maximum number of results to return.                                        |
| Offset             | integer | No       | non-negative integer, optional, default: 0. Default: 0.                         |
| Order By           | string  | No       | Order results by values of the specified attribute.                             |
| Sort Order         | string  | No       | Sort results is ascending or descending observation\_date order.                |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Related Tags For Series Search Results.

Use this tool to get get related tags for series search results.

**Inputs**

| Field              | Type    | Required | Description                                                                     |
| ------------------ | ------- | -------- | ------------------------------------------------------------------------------- |
| Api Key            | string  | Yes      | Read API Keys for more information.                                             |
| File Type          | string  | No       | A key or file extension that indicates the type of file to send. Default: json. |
| Series Search Text | string  | Yes      | The words to match against economic data series.                                |
| Realtime Start     | string  | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End       | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.   |
| Tag Names          | string  | Yes      | A semicolon delimited list of tag names that series match all of.               |
| Exclude Tag Names  | string  | No       | A semicolon delimited list of tag names that series match none of.              |
| Tag Group Id       | string  | No       | A tag group id to filter tags by type.                                          |
| Tag Search Text    | string  | No       | The words to find matching tags with.                                           |
| Limit              | integer | No       | The maximum number of results to return.                                        |
| Offset             | integer | No       | non-negative integer, optional, default: 0. Default: 0.                         |
| Order By           | string  | No       | Order results by values of the specified attribute.                             |
| Sort Order         | string  | No       | Sort results is ascending or descending observation\_date order.                |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Series Tags

Use this tool to get get series tags

**Inputs**

| Field          | Type   | Required | Description                                                                     |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Description    | string | No       | Get the observations or data values for an economic data series.                |
| Api Key        | string | No       | Read API Keys for more information.                                             |
| File Type      | string | No       | A key or file extension that indicates the type of file to send.                |
| Series Id      | string | No       | The id for a series.                                                            |
| Realtime Start | string | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string | No       | The end of the real-time period. For more information, see Real-Time Periods.   |
| Order By       | string | No       | Order results by values of the specified attribute.                             |
| Sort Order     | string | No       | Sort results is ascending or descending observation\_date order.                |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Series Updates

Use this tool to get get series updates

**Inputs**

| Field          | Type    | Required | Description                                                                     |
| -------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Description    | string  | No       | Get the observations or data values for an economic data series.                |
| Api Key        | string  | No       | Read API Keys for more information.                                             |
| File Type      | string  | No       | A key or file extension that indicates the type of file to send.                |
| Realtime Start | string  | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.   |
| Limit          | string  | No       | The maximum number of results to return.                                        |
| Offset         | integer | No       | non-negative integer, optional, default: 0. Default: 0.                         |
| Filter Value   | string  | No       | The value of the filter\_variable attribute to filter results by.               |
| Start Time     | string  | No       | Start time for limiting results for a time range, can filter down to minutes.   |
| End Time       | string  | No       | End time for limiting results for a time range, can filter down to minutes.     |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Series Vintagedates

Use this tool to get get series vintagedates

**Inputs**

| Field          | Type    | Required | Description                                                                     |
| -------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Description    | string  | No       | Get the observations or data values for an economic data series.                |
| Api Key        | string  | No       | Read API Keys for more information.                                             |
| File Type      | string  | No       | A key or file extension that indicates the type of file to send.                |
| Series Id      | string  | No       | The id for a series.                                                            |
| Realtime Start | string  | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.   |
| Limit          | string  | No       | The maximum number of results to return.                                        |
| Offset         | integer | No       | non-negative integer, optional, default: 0. Default: 0.                         |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Sources

Use this tool to get get sources

**Inputs**

| Field          | Type    | Required | Description                                                                                |
| -------------- | ------- | -------- | ------------------------------------------------------------------------------------------ |
| Description    | string  | No       | Get all sources of economic data.                                                          |
| Api Key        | string  | No       | Read API Keys for more information.                                                        |
| File Type      | string  | No       | A key or file extension that indicates the type of file to send.                           |
| Realtime Start | string  | No       | The start of the real-time period. For more information, see Real-Time Periods.            |
| Realtime End   | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.              |
| Limit          | string  | No       | The maximum number of results to return.                                                   |
| Offset         | integer | No       | non-negative integer, optional, default: 0. Default: 0.                                    |
| Order By       | string  | No       | Order results by values of the specified attribute.                                        |
| Sort Order     | string  | No       | Sort results is ascending or descending order for attribute values specified by order\_by. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Source

Use this tool to get get source

**Inputs**

| Field          | Type   | Required | Description                                                                     |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Description    | string | No       | Get all sources of economic data.                                               |
| Api Key        | string | No       | Read API Keys for more information.                                             |
| File Type      | string | No       | A key or file extension that indicates the type of file to send.                |
| Source Id      | string | No       | The id for a source.                                                            |
| Realtime Start | string | No       | The start of the real-time period. For more information, see Real-Time Periods. |
| Realtime End   | string | No       | The end of the real-time period. For more information, see Real-Time Periods.   |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Source Releases

Use this tool to get get source releases

**Inputs**

| Field          | Type    | Required | Description                                                                                |
| -------------- | ------- | -------- | ------------------------------------------------------------------------------------------ |
| The            | string  | No       | #Description.                                                                              |
| Description    | string  | No       | Get all sources of economic data.                                                          |
| Api Key        | string  | No       | Read API Keys for more information.                                                        |
| File Type      | string  | No       | A key or file extension that indicates the type of file to send.                           |
| Source Id      | string  | No       | The id for a source.                                                                       |
| Realtime Start | string  | No       | The start of the real-time period. For more information, see Real-Time Periods.            |
| Realtime End   | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.              |
| Limit          | string  | No       | The maximum number of results to return.                                                   |
| Offset         | integer | No       | non-negative integer, optional, default: 0. Default: 0.                                    |
| Order By       | string  | No       | Order results by values of the specified attribute.                                        |
| Sort Order     | string  | No       | Sort results is ascending or descending order for attribute values specified by order\_by. |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Tags

Use this tool to get get tags

**Inputs**

| Field          | Type    | Required | Description                                                                                                                                                           |
| -------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Description    | string  | No       | Get FRED tags. Optionally, filter results by tag name, tag group, or search. FRED tags are attributes assigned to series. See the related request fred/related\_tags. |
| Api Key        | string  | No       | Read API Keys for more information.                                                                                                                                   |
| File Type      | string  | No       | A key or file extension that indicates the type of file to send.                                                                                                      |
| Realtime Start | string  | No       | The start of the real-time period. For more information, see Real-Time Periods.                                                                                       |
| Realtime End   | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.                                                                                         |
| Tag Names      | string  | No       | A semicolon delimited list of tag names to only include in the response. See the related request fred/related\_tags.                                                  |
| Tag Group Id   | string  | No       | A tag group id to filter tags by type.                                                                                                                                |
| Search Text    | string  | No       | The words to find matching tags with.                                                                                                                                 |
| Limit          | string  | No       | The maximum number of results to return.                                                                                                                              |
| Offset         | integer | No       | non-negative integer, optional, default: 0. Default: 0.                                                                                                               |
| Order By       | string  | No       | Order results by values of the specified attribute.                                                                                                                   |
| Sort Order     | string  | No       | Sort results is ascending or descending order for attribute values specified by order\_by.                                                                            |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Related\_ Tags

Use this tool to get get related\_ tags

**Inputs**

| Field          | Type    | Required | Description                                                                                                                                                           |
| -------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Description    | string  | No       | Get FRED tags. Optionally, filter results by tag name, tag group, or search. FRED tags are attributes assigned to series. See the related request fred/related\_tags. |
| Api Key        | string  | No       | Read API Keys for more information.                                                                                                                                   |
| File Type      | string  | No       | A key or file extension that indicates the type of file to send.                                                                                                      |
| Realtime Start | string  | No       | The start of the real-time period. For more information, see Real-Time Periods.                                                                                       |
| Realtime End   | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.                                                                                         |
| Tag Names      | string  | No       | A semicolon delimited list of tag names to only include in the response. See the related request fred/related\_tags.                                                  |
| Tag Group Id   | string  | No       | A tag group id to filter tags by type.                                                                                                                                |
| Search Text    | string  | No       | The words to find matching tags with.                                                                                                                                 |
| Limit          | string  | No       | The maximum number of results to return.                                                                                                                              |
| Offset         | integer | No       | non-negative integer, optional, default: 0. Default: 0.                                                                                                               |
| Order By       | string  | No       | Order results by values of the specified attribute.                                                                                                                   |
| Sort Order     | string  | No       | Sort results is ascending or descending order for attribute values specified by order\_by.                                                                            |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

#### Get Tags Series

Use this tool to get get tags series

**Inputs**

| Field             | Type    | Required | Description                                                                                                                                                           |
| ----------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Description       | string  | No       | Get FRED tags. Optionally, filter results by tag name, tag group, or search. FRED tags are attributes assigned to series. See the related request fred/related\_tags. |
| Api Key           | string  | No       | Read API Keys for more information.                                                                                                                                   |
| File Type         | string  | No       | A key or file extension that indicates the type of file to send.                                                                                                      |
| Tag Names         | string  | No       | A semicolon delimited list of tag names to only include in the response. See the related request fred/related\_tags.                                                  |
| Exclude Tag Names | string  | No       | A semicolon delimited list of tag names that series match none of.                                                                                                    |
| Realtime Start    | string  | No       | The start of the real-time period. For more information, see Real-Time Periods.                                                                                       |
| Realtime End      | string  | No       | The end of the real-time period. For more information, see Real-Time Periods.                                                                                         |
| Limit             | string  | No       | The maximum number of results to return.                                                                                                                              |
| Offset            | integer | No       | non-negative integer, optional, default: 0. Default: 0.                                                                                                               |
| Order By          | string  | No       | Order results by values of the specified attribute.                                                                                                                   |
| Sort Order        | string  | No       | Sort results is ascending or descending order for attribute values specified by order\_by.                                                                            |

**Outputs**

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/fred.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
