FRED Economic Data data contract

Provenance

PublisherFRED Economic Data

API basehttps://api.stlouisfed.org/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (8)

searchSeries

read

Search economic data series by text, type, ordering, and pagination.

Input schema

{
  "type": "object",
  "properties": {
    "search_text": {
      "type": "string"
    },
    "searchText": {
      "type": "string"
    },
    "search_type": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "full_text"
          ]
        },
        {
          "type": "string",
          "enum": [
            "series_id"
          ]
        }
      ]
    },
    "searchType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "full_text"
          ]
        },
        {
          "type": "string",
          "enum": [
            "series_id"
          ]
        }
      ]
    },
    "order_by": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "popularity"
          ]
        },
        {
          "type": "string",
          "enum": [
            "series_id"
          ]
        },
        {
          "type": "string",
          "enum": [
            "search_rank"
          ]
        },
        {
          "type": "string",
          "enum": [
            "title"
          ]
        },
        {
          "type": "string",
          "enum": [
            "units"
          ]
        },
        {
          "type": "string",
          "enum": [
            "frequency"
          ]
        },
        {
          "type": "string",
          "enum": [
            "seasonal_adjustment"
          ]
        },
        {
          "type": "string",
          "enum": [
            "realtime_start"
          ]
        },
        {
          "type": "string",
          "enum": [
            "realtime_end"
          ]
        },
        {
          "type": "string",
          "enum": [
            "last_updated"
          ]
        },
        {
          "type": "string",
          "enum": [
            "observation_start"
          ]
        },
        {
          "type": "string",
          "enum": [
            "observation_end"
          ]
        },
        {
          "type": "string",
          "enum": [
            "group_popularity"
          ]
        }
      ]
    },
    "orderBy": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "popularity"
          ]
        },
        {
          "type": "string",
          "enum": [
            "series_id"
          ]
        },
        {
          "type": "string",
          "enum": [
            "search_rank"
          ]
        },
        {
          "type": "string",
          "enum": [
            "title"
          ]
        },
        {
          "type": "string",
          "enum": [
            "units"
          ]
        },
        {
          "type": "string",
          "enum": [
            "frequency"
          ]
        },
        {
          "type": "string",
          "enum": [
            "seasonal_adjustment"
          ]
        },
        {
          "type": "string",
          "enum": [
            "realtime_start"
          ]
        },
        {
          "type": "string",
          "enum": [
            "realtime_end"
          ]
        },
        {
          "type": "string",
          "enum": [
            "last_updated"
          ]
        },
        {
          "type": "string",
          "enum": [
            "observation_start"
          ]
        },
        {
          "type": "string",
          "enum": [
            "observation_end"
          ]
        },
        {
          "type": "string",
          "enum": [
            "group_popularity"
          ]
        }
      ]
    },
    "sort_order": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "asc"
          ]
        },
        {
          "type": "string",
          "enum": [
            "desc"
          ]
        }
      ]
    },
    "sortOrder": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "asc"
          ]
        },
        {
          "type": "string",
          "enum": [
            "desc"
          ]
        }
      ]
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "tag_names": {
      "type": "string"
    },
    "tagNames": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "search_text"
  ]
}

getSeriesObservations

read

Retrieve observations for an economic series within dates, frequency, units, and aggregation settings.

Input schema

{
  "type": "object",
  "properties": {
    "series_id": {
      "type": "string"
    },
    "seriesId": {
      "type": "string"
    },
    "observation_start": {
      "type": "string"
    },
    "observationStart": {
      "type": "string"
    },
    "observation_end": {
      "type": "string"
    },
    "observationEnd": {
      "type": "string"
    },
    "frequency": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "d"
          ]
        },
        {
          "type": "string",
          "enum": [
            "w"
          ]
        },
        {
          "type": "string",
          "enum": [
            "bw"
          ]
        },
        {
          "type": "string",
          "enum": [
            "m"
          ]
        },
        {
          "type": "string",
          "enum": [
            "q"
          ]
        },
        {
          "type": "string",
          "enum": [
            "sa"
          ]
        },
        {
          "type": "string",
          "enum": [
            "a"
          ]
        }
      ]
    },
    "units": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "lin"
          ]
        },
        {
          "type": "string",
          "enum": [
            "chg"
          ]
        },
        {
          "type": "string",
          "enum": [
            "ch1"
          ]
        },
        {
          "type": "string",
          "enum": [
            "pch"
          ]
        },
        {
          "type": "string",
          "enum": [
            "pc1"
          ]
        },
        {
          "type": "string",
          "enum": [
            "pca"
          ]
        },
        {
          "type": "string",
          "enum": [
            "cch"
          ]
        },
        {
          "type": "string",
          "enum": [
            "cca"
          ]
        },
        {
          "type": "string",
          "enum": [
            "log"
          ]
        }
      ]
    },
    "aggregation_method": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "avg"
          ]
        },
        {
          "type": "string",
          "enum": [
            "sum"
          ]
        },
        {
          "type": "string",
          "enum": [
            "eop"
          ]
        }
      ]
    },
    "aggregationMethod": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "avg"
          ]
        },
        {
          "type": "string",
          "enum": [
            "sum"
          ]
        },
        {
          "type": "string",
          "enum": [
            "eop"
          ]
        }
      ]
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "sort_order": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "asc"
          ]
        },
        {
          "type": "string",
          "enum": [
            "desc"
          ]
        }
      ]
    },
    "sortOrder": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "asc"
          ]
        },
        {
          "type": "string",
          "enum": [
            "desc"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "series_id"
  ]
}

getSeriesInfo

read

Retrieve metadata for one economic data series by series identifier.

Input schema

{
  "type": "object",
  "properties": {
    "series_id": {
      "type": "string"
    },
    "seriesId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "series_id"
  ]
}

getCategory

read

Retrieve details for one economic data category by category identifier.

Input schema

{
  "type": "object",
  "properties": {
    "category_id": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "category_id"
  ]
}

getCategoryChildren

read

List child categories under an economic data category.

Input schema

{
  "type": "object",
  "properties": {
    "category_id": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "category_id"
  ]
}

getLatestObservation

read

Retrieve the latest observation for one economic data series.

Input schema

{
  "type": "object",
  "properties": {
    "series_id": {
      "type": "string"
    },
    "seriesId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "series_id"
  ]
}

getMultipleSeriesObservations

read

Retrieve observations for multiple economic data series within an optional date range.

Input schema

{
  "type": "object",
  "properties": {
    "series_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "seriesIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "observation_start": {
      "type": "string"
    },
    "observationStart": {
      "type": "string"
    },
    "observation_end": {
      "type": "string"
    },
    "observationEnd": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "series_ids"
  ]
}

getCategorySeries

read

List economic data series in a category with ordering and pagination.

Input schema

{
  "type": "object",
  "properties": {
    "category_id": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "order_by": {
      "type": "string"
    },
    "sort_order": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "asc"
          ]
        },
        {
          "type": "string",
          "enum": [
            "desc"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "category_id"
  ]
}