get_fred_series_observations
Retrieve economic time series observations from the Federal Reserve Bank of St. Louis (FRED) by specifying series ID, date ranges, frequency, and other parameters for data analysis.
Instructions
Get series observations from the Fred API.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aggregation_method | No | Aggregation method for frequency. Options: 'avg', 'sum', 'eop'. Defaults to 'avg'. | avg |
| frequency | No | Frequency of observations. Options: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'. Defaults to no value for no frequency aggregation. | |
| limit | No | Maximum number of observations to return. Defaults to 10. | |
| observation_end | No | End date of observations. Format: YYYY-MM-DD. | |
| observation_start | No | Start date of observations. Format: YYYY-MM-DD. | |
| offset | No | Number of observations to offset from first. Defaults to 0. | |
| output_type | No | Output type of observations. Options: 1, 2, 3, 4. Defaults to 1. | |
| realtime_end | No | The end of the real-time period. Format: YYYY-MM-DD. Defaults to today's date. | |
| realtime_start | No | The start of the real-time period. Format: YYYY-MM-DD. Defaults to today's date. | |
| series_id | Yes | The id for a series. | |
| sort_order | No | Sort order of observations. Options: 'asc' or 'desc'. Defaults to 'asc'. | asc |
| units | No | Data value transformation. Options: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'. Defaults to 'lin'. | lin |
| vintage_dates | No | Comma-separated list of vintage dates. |
Input Schema (JSON Schema)
{
"properties": {
"aggregation_method": {
"default": "avg",
"description": "Aggregation method for frequency. Options: 'avg', 'sum', 'eop'. Defaults to 'avg'.",
"enum": [
"avg",
"sum",
"eop"
],
"title": "Aggregation Method",
"type": "string"
},
"frequency": {
"default": null,
"description": "Frequency of observations. Options: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'. Defaults to no value for no frequency aggregation.",
"enum": [
"d",
"w",
"bw",
"m",
"q",
"sa",
"a",
"wef",
"weth",
"wew",
"wetu",
"wem",
"wesu",
"wesa",
"bwew",
"bwem"
],
"title": "Frequency",
"type": "string"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": 10,
"description": "Maximum number of observations to return. Defaults to 10.",
"title": "Limit"
},
"observation_end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date of observations. Format: YYYY-MM-DD.",
"title": "Observation End"
},
"observation_start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date of observations. Format: YYYY-MM-DD.",
"title": "Observation Start"
},
"offset": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": 0,
"description": "Number of observations to offset from first. Defaults to 0.",
"title": "Offset"
},
"output_type": {
"default": 1,
"description": "Output type of observations. Options: 1, 2, 3, 4. Defaults to 1.",
"enum": [
1,
2,
3,
4
],
"title": "Output Type",
"type": "integer"
},
"realtime_end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The end of the real-time period. Format: YYYY-MM-DD. Defaults to today's date.",
"title": "Realtime End"
},
"realtime_start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The start of the real-time period. Format: YYYY-MM-DD. Defaults to today's date.",
"title": "Realtime Start"
},
"series_id": {
"description": "The id for a series.",
"title": "Series Id",
"type": "string"
},
"sort_order": {
"default": "asc",
"description": "Sort order of observations. Options: 'asc' or 'desc'. Defaults to 'asc'.",
"enum": [
"asc",
"desc"
],
"title": "Sort Order",
"type": "string"
},
"units": {
"default": "lin",
"description": "Data value transformation. Options: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'. Defaults to 'lin'.",
"enum": [
"lin",
"chg",
"ch1",
"pch",
"pc1",
"pca",
"cch",
"cca",
"log"
],
"title": "Units",
"type": "string"
},
"vintage_dates": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Comma-separated list of vintage dates.",
"title": "Vintage Dates"
}
},
"required": [
"series_id"
],
"title": "get_fred_series_observationsArguments",
"type": "object"
}