openapi: 3.0.3
info:
title: FRED API
version: '1.0'
description: >-
Federal Reserve Economic Data (FRED) API — the public web service operated
by the Research Division of the Federal Reserve Bank of St. Louis. Provides
programmatic access to 800,000+ economic time series across Categories,
Releases, Series, Sources, and Tags endpoint families plus the underlying
Series Observations endpoint that returns the actual time-series values.
All endpoints accept an api_key, optional realtime_start / realtime_end
parameters (ALFRED vintages), and a file_type parameter (xml | json).
contact:
name: Federal Reserve Bank of St. Louis — Research Division
url: https://fred.stlouisfed.org/docs/api/fred/
license:
name: U.S. Government Work / Public Domain (most series)
url: https://fred.stlouisfed.org/legal/
termsOfService: https://fred.stlouisfed.org/legal/
x-generated-from: documentation
x-last-validated: '2026-05-28'
servers:
- url: https://api.stlouisfed.org/fred
description: Production FRED API
tags:
- name: Categories
description: Category hierarchy navigation — children, related, series, and tags within a category.
- name: Releases
description: Economic data releases — schedules, member series, sources, and tags per release.
- name: Series
description: Economic data series metadata, search, categorization, release linkage, tags, updates, and vintages.
- name: Observations
description: The underlying time-series data values, with frequency aggregation and unit transformations.
- name: Sources
description: Originating institutions for FRED series (BLS, BEA, OECD, etc.) and the releases they publish.
- name: Tags
description: Faceted classification across FRED — tag listings, related tags, and tag-matched series.
security:
- ApiKeyAuth: []
paths:
# ─────────────────────────────────────────────────────────────────────
# CATEGORIES
# ─────────────────────────────────────────────────────────────────────
/category:
get:
operationId: getCategory
summary: FRED Get a Category
description: Get a category by ID.
tags: [Categories]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- name: category_id
in: query
required: true
description: Numeric ID of the FRED category to retrieve.
schema: {type: integer, default: 0}
example: 125
responses:
'200':
description: A single category.
content:
application/json:
schema: {$ref: '#/components/schemas/CategoryList'}
examples:
Getcategory200Example:
summary: Default getCategory 200 response
x-microcks-default: true
value:
categories:
- id: 125
name: Trade Balance
parent_id: 13
- id: 13
name: International Data
parent_id: 0
'400': {$ref: '#/components/responses/BadRequest'}
'403': {$ref: '#/components/responses/Forbidden'}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/category/children:
get:
operationId: getCategoryChildren
summary: FRED Get the Child Categories for a Category
description: Get the child categories for a specified parent category.
tags: [Categories]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: category_id, in: query, required: true, description: Parent category ID., schema: {type: integer, default: 0}, example: 125}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
responses:
'200':
description: List of child categories.
content:
application/json:
schema: {$ref: '#/components/schemas/CategoryList'}
examples:
Getcategorychildren200Example:
summary: Default getCategoryChildren 200 response
x-microcks-default: true
value:
categories:
- id: 125
name: Trade Balance
parent_id: 13
- id: 13
name: International Data
parent_id: 0
'400': {$ref: '#/components/responses/BadRequest'}
'403': {$ref: '#/components/responses/Forbidden'}
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/category/related:
get:
operationId: getCategoryRelated
summary: FRED Get the Related Categories for a Category
description: Get the related categories for a category. Two categories are related when one is not the parent or child of the other but the FRED editorial staff have judged them as related.
tags: [Categories]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: category_id, in: query, required: true, description: The seed category ID., schema: {type: integer}, example: 125}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
responses:
'200':
description: List of related categories.
content:
application/json:
schema: {$ref: '#/components/schemas/CategoryList'}
examples:
Getcategoryrelated200Example:
summary: Default getCategoryRelated 200 response
x-microcks-default: true
value:
categories:
- id: 125
name: Trade Balance
parent_id: 13
- id: 13
name: International Data
parent_id: 0
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/category/series:
get:
operationId: getCategorySeries
summary: FRED Get the Series in a Category
description: Get the series in a category.
tags: [Categories]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: category_id, in: query, required: true, description: The category to enumerate., schema: {type: integer}, example: 125}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderBySeries'
- $ref: '#/components/parameters/SortOrder'
- $ref: '#/components/parameters/FilterVariable'
- $ref: '#/components/parameters/FilterValue'
- $ref: '#/components/parameters/TagNames'
- $ref: '#/components/parameters/ExcludeTagNames'
responses:
'200':
description: Series in the category.
content:
application/json:
schema: {$ref: '#/components/schemas/SeriesList'}
examples:
Getcategoryseries200Example:
summary: Default getCategorySeries 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: series_id
sort_order: asc
count: 1
offset: 0
limit: 1000
seriess:
- id: UNRATE
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
title: Unemployment Rate
observation_start: '1948-01-01'
observation_end: '2026-04-01'
frequency: Monthly
frequency_short: M
units: Percent
units_short: '%'
seasonal_adjustment: Seasonally Adjusted
seasonal_adjustment_short: SA
last_updated: '2026-05-02 07:46:10-05'
popularity: 95
group_popularity: 95
notes: The unemployment rate represents the number of unemployed as a percentage of the labor force.
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/category/tags:
get:
operationId: getCategoryTags
summary: FRED Get the Tags for a Category
description: Get the FRED tags for a category.
tags: [Categories]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: category_id, in: query, required: true, description: The category to list tags for., schema: {type: integer}, example: 125}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/TagNames'
- $ref: '#/components/parameters/TagGroupId'
- $ref: '#/components/parameters/SearchText'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderByTags'
- $ref: '#/components/parameters/SortOrder'
responses:
'200':
description: Tags for the category.
content:
application/json:
schema: {$ref: '#/components/schemas/TagList'}
examples:
Getcategorytags200Example:
summary: Default getCategoryTags 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: series_count
sort_order: desc
count: 2
offset: 0
limit: 1000
tags:
- name: monthly
group_id: freq
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 100
series_count: 380000
- name: nation
group_id: geot
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 99
series_count: 110000
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/category/related_tags:
get:
operationId: getCategoryRelatedTags
summary: FRED Get the Related Tags for a Category
description: Get the related FRED tags for one or more FRED tags within a category.
tags: [Categories]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: category_id, in: query, required: true, schema: {type: integer}, description: Seed category., example: 125}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/TagNames'
- $ref: '#/components/parameters/ExcludeTagNames'
- $ref: '#/components/parameters/TagGroupId'
- $ref: '#/components/parameters/SearchText'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderByTags'
- $ref: '#/components/parameters/SortOrder'
responses:
'200':
description: Related tags for the category.
content:
application/json:
schema: {$ref: '#/components/schemas/TagList'}
examples:
Getcategoryrelatedtags200Example:
summary: Default getCategoryRelatedTags 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: series_count
sort_order: desc
count: 2
offset: 0
limit: 1000
tags:
- name: monthly
group_id: freq
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 100
series_count: 380000
- name: nation
group_id: geot
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 99
series_count: 110000
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
# ─────────────────────────────────────────────────────────────────────
# RELEASES
# ─────────────────────────────────────────────────────────────────────
/releases:
get:
operationId: getReleases
summary: FRED Get All Releases of Economic Data
description: Get all releases of economic data.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderByReleases'
- $ref: '#/components/parameters/SortOrder'
responses:
'200':
description: All releases.
content:
application/json:
schema: {$ref: '#/components/schemas/ReleaseList'}
examples:
Getreleases200Example:
summary: Default getReleases 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: release_id
sort_order: asc
count: 326
offset: 0
limit: 1000
releases:
- id: 9
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
name: Advance Monthly Sales for Retail and Food Services
press_release: true
link: http://www.census.gov/retail/
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/releases/dates:
get:
operationId: getReleasesDates
summary: FRED Get Release Dates for All Releases of Economic Data
description: Get release dates for all releases of economic data.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- {name: order_by, in: query, schema: {type: string, enum: [release_date, release_id, release_name]}, description: Ordering field., example: series_count}
- $ref: '#/components/parameters/SortOrder'
- {name: include_release_dates_with_no_data, in: query, schema: {type: boolean, default: false}, description: Include releases that have no data., example: false}
responses:
'200':
description: Release dates across all releases.
content:
application/json:
schema: {$ref: '#/components/schemas/ReleaseDateList'}
examples:
Getreleasesdates200Example:
summary: Default getReleasesDates 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: release_date
sort_order: asc
count: 1
offset: 0
limit: 1000
release_dates:
- release_id: 9
release_name: Advance Monthly Sales for Retail and Food Services
date: '2026-05-14'
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release:
get:
operationId: getRelease
summary: FRED Get a Release of Economic Data
description: Get a release of economic data by ID.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
responses:
'200':
description: A single release.
content:
application/json:
schema: {$ref: '#/components/schemas/ReleaseList'}
examples:
Getrelease200Example:
summary: Default getRelease 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: release_id
sort_order: asc
count: 326
offset: 0
limit: 1000
releases:
- id: 9
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
name: Advance Monthly Sales for Retail and Food Services
press_release: true
link: http://www.census.gov/retail/
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release/dates:
get:
operationId: getReleaseDates
summary: FRED Get the Release Dates for a Release of Economic Data
description: Get the release dates for a release of economic data.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/Limit10000'
- $ref: '#/components/parameters/Offset'
- {name: sort_order, in: query, schema: {type: string, enum: [asc, desc]}, description: Sort by release date., example: asc}
- {name: include_release_dates_with_no_data, in: query, schema: {type: boolean, default: false}, description: Include dates that have no data attached., example: false}
responses:
'200':
description: Release dates for the release.
content:
application/json:
schema: {$ref: '#/components/schemas/ReleaseDateList'}
examples:
Getreleasedates200Example:
summary: Default getReleaseDates 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: release_date
sort_order: asc
count: 1
offset: 0
limit: 1000
release_dates:
- release_id: 9
release_name: Advance Monthly Sales for Retail and Food Services
date: '2026-05-14'
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release/series:
get:
operationId: getReleaseSeries
summary: FRED Get the Series on a Release of Economic Data
description: Get the series on a release of economic data.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderBySeries'
- $ref: '#/components/parameters/SortOrder'
- $ref: '#/components/parameters/FilterVariable'
- $ref: '#/components/parameters/FilterValue'
- $ref: '#/components/parameters/TagNames'
- $ref: '#/components/parameters/ExcludeTagNames'
responses:
'200':
description: Series on the release.
content:
application/json:
schema: {$ref: '#/components/schemas/SeriesList'}
examples:
Getreleaseseries200Example:
summary: Default getReleaseSeries 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: series_id
sort_order: asc
count: 1
offset: 0
limit: 1000
seriess:
- id: UNRATE
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
title: Unemployment Rate
observation_start: '1948-01-01'
observation_end: '2026-04-01'
frequency: Monthly
frequency_short: M
units: Percent
units_short: '%'
seasonal_adjustment: Seasonally Adjusted
seasonal_adjustment_short: SA
last_updated: '2026-05-02 07:46:10-05'
popularity: 95
group_popularity: 95
notes: The unemployment rate represents the number of unemployed as a percentage of the labor force.
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release/sources:
get:
operationId: getReleaseSources
summary: FRED Get the Sources for a Release of Economic Data
description: Get the sources for a release of economic data.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
responses:
'200':
description: Sources for the release.
content:
application/json:
schema: {$ref: '#/components/schemas/SourceList'}
examples:
Getreleasesources200Example:
summary: Default getReleaseSources 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: source_id
sort_order: asc
count: 1
offset: 0
limit: 1000
sources:
- id: 1
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
name: Board of Governors of the Federal Reserve System (US)
link: http://www.federalreserve.gov/
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release/tags:
get:
operationId: getReleaseTags
summary: FRED Get the Tags for a Release
description: Get the FRED tags for a release.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/TagNames'
- $ref: '#/components/parameters/TagGroupId'
- $ref: '#/components/parameters/SearchText'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderByTags'
- $ref: '#/components/parameters/SortOrder'
responses:
'200':
description: Tags for the release.
content:
application/json:
schema: {$ref: '#/components/schemas/TagList'}
examples:
Getreleasetags200Example:
summary: Default getReleaseTags 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: series_count
sort_order: desc
count: 2
offset: 0
limit: 1000
tags:
- name: monthly
group_id: freq
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 100
series_count: 380000
- name: nation
group_id: geot
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 99
series_count: 110000
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release/related_tags:
get:
operationId: getReleaseRelatedTags
summary: FRED Get the Related Tags for a Release
description: Get the related FRED tags for one or more FRED tags within a release.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
- $ref: '#/components/parameters/TagNames'
- $ref: '#/components/parameters/ExcludeTagNames'
- $ref: '#/components/parameters/TagGroupId'
- $ref: '#/components/parameters/SearchText'
- $ref: '#/components/parameters/Limit1000'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/OrderByTags'
- $ref: '#/components/parameters/SortOrder'
responses:
'200':
description: Related tags for the release.
content:
application/json:
schema: {$ref: '#/components/schemas/TagList'}
examples:
Getreleaserelatedtags200Example:
summary: Default getReleaseRelatedTags 200 response
x-microcks-default: true
value:
realtime_start: '2026-05-28'
realtime_end: '2026-05-28'
order_by: series_count
sort_order: desc
count: 2
offset: 0
limit: 1000
tags:
- name: monthly
group_id: freq
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 100
series_count: 380000
- name: nation
group_id: geot
notes: ''
created: '2012-02-27 10:18:19-06'
popularity: 99
series_count: 110000
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
/release/tables:
get:
operationId: getReleaseTables
summary: FRED Get Release Tables
description: Get release table trees for a given release. Returns the table tree of a release.
tags: [Releases]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: release_id, in: query, required: true, schema: {type: integer}, description: Numeric release ID., example: 9}
- {name: element_id, in: query, schema: {type: integer}, description: Optional element of the release table to root the tree at., example: 12886}
- {name: include_observation_values, in: query, schema: {type: boolean, default: false}, description: Include observation values inline., example: false}
- {name: observation_date, in: query, schema: {type: string, format: date}, description: Date of the observations to include (YYYY-MM-DD)., example: '2026-04-01'}
responses:
'200':
description: Release table tree.
content:
application/json:
schema: {$ref: '#/components/schemas/ReleaseTable'}
examples:
Getreleasetables200Example:
summary: Default getReleaseTables 200 response
x-microcks-default: true
value:
name: Personal consumption expenditures
element_id: 12886
release_id: 53
elements:
'12886':
element_id: 12886
release_id: 53
series_id: DGDSRC1
parent_id: 12885
line: '5'
type: series
name: Goods
level: '1'
children: []
x-microcks-operation: {delay: 0, dispatcher: FALLBACK}
# ─────────────────────────────────────────────────────────────────────
# SERIES
# ─────────────────────────────────────────────────────────────────────
/series:
get:
operationId: getSeries
summary: FRED Get an Economic Data Series
description: Get an economic data series by ID.
tags: [Series]
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/FileType'
- {name: series_id, in: query, required: true, schema: {type: string}, description: The FRED series ID (e.g. GNPCA, UNRATE).: null, example: UNRATE}
- $ref: '#/components/parameters/RealtimeStart'
- $ref: '#/components/parameters/RealtimeEnd'
responses:
'200':
description: A single series.
con
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fred/refs/heads/main/openapi/fred-openapi.yml