{ "opencollection": "1.0.0", "info": { "name": "FRED API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "items": [ { "info": { "name": "Categories", "type": "folder" }, "items": [ { "info": { "name": "FRED Get a Category", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/category", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "category_id", "value": "125", "type": "query", "description": "Numeric ID of the FRED category to retrieve." } ] }, "docs": "Get a category by ID." }, { "info": { "name": "FRED Get the Child Categories for a Category", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/category/children", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "category_id", "value": "125", "type": "query", "description": "Parent category ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get the child categories for a specified parent category." }, { "info": { "name": "FRED Get the Related Categories for a Category", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/category/related", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "category_id", "value": "125", "type": "query", "description": "The seed category ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "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." }, { "info": { "name": "FRED Get the Series in a Category", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/category/series", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "category_id", "value": "125", "type": "query", "description": "The category to enumerate." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order series results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." }, { "name": "filter_variable", "value": "frequency", "type": "query", "description": "Attribute to filter series results by." }, { "name": "filter_value", "value": "monthly", "type": "query", "description": "Value of the filter_variable attribute to match." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." } ] }, "docs": "Get the series in a category." }, { "info": { "name": "FRED Get the Tags for a Category", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/category/tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "category_id", "value": "125", "type": "query", "description": "The category to list tags for." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against tag names and descriptions." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the FRED tags for a category." }, { "info": { "name": "FRED Get the Related Tags for a Category", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/category/related_tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "category_id", "value": "125", "type": "query", "description": "Seed category." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against tag names and descriptions." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the related FRED tags for one or more FRED tags within a category." } ] }, { "info": { "name": "Releases", "type": "folder" }, "items": [ { "info": { "name": "FRED Get All Releases of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/releases", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order release results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get all releases of economic data." }, { "info": { "name": "FRED Get Release Dates for All Releases of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/releases/dates", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Ordering field." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." }, { "name": "include_release_dates_with_no_data", "value": "false", "type": "query", "description": "Include releases that have no data." } ] }, "docs": "Get release dates for all releases of economic data." }, { "info": { "name": "FRED Get a Release of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get a release of economic data by ID." }, { "info": { "name": "FRED Get the Release Dates for a Release of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release/dates", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–10000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort by release date." }, { "name": "include_release_dates_with_no_data", "value": "false", "type": "query", "description": "Include dates that have no data attached." } ] }, "docs": "Get the release dates for a release of economic data." }, { "info": { "name": "FRED Get the Series on a Release of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release/series", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order series results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." }, { "name": "filter_variable", "value": "frequency", "type": "query", "description": "Attribute to filter series results by." }, { "name": "filter_value", "value": "monthly", "type": "query", "description": "Value of the filter_variable attribute to match." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." } ] }, "docs": "Get the series on a release of economic data." }, { "info": { "name": "FRED Get the Sources for a Release of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release/sources", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get the sources for a release of economic data." }, { "info": { "name": "FRED Get the Tags for a Release", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release/tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against tag names and descriptions." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the FRED tags for a release." }, { "info": { "name": "FRED Get the Related Tags for a Release", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release/related_tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against tag names and descriptions." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the related FRED tags for one or more FRED tags within a release." }, { "info": { "name": "FRED Get Release Tables", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/release/tables", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "release_id", "value": "9", "type": "query", "description": "Numeric release ID." }, { "name": "element_id", "value": "12886", "type": "query", "description": "Optional element of the release table to root the tree at." }, { "name": "include_observation_values", "value": "false", "type": "query", "description": "Include observation values inline." }, { "name": "observation_date", "value": "2026-04-01", "type": "query", "description": "Date of the observations to include (YYYY-MM-DD)." } ] }, "docs": "Get release table trees for a given release. Returns the table tree of a release." } ] }, { "info": { "name": "Series", "type": "folder" }, "items": [ { "info": { "name": "FRED Get an Economic Data Series", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_id", "value": "UNRATE", "type": "query", "description": "The FRED series ID (e.g. GNPCA" }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get an economic data series by ID." }, { "info": { "name": "FRED Get the Categories for an Economic Data Series", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/categories", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_id", "value": "UNRATE", "type": "query", "description": "The FRED series ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get the categories for an economic data series." }, { "info": { "name": "FRED Get the Release for an Economic Data Series", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/release", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_id", "value": "UNRATE", "type": "query", "description": "The FRED series ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get the release for an economic data series." }, { "info": { "name": "FRED Get Economic Data Series That Match Keywords", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/search", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against series IDs" }, { "name": "search_type", "value": "", "type": "query", "description": "Type of search." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Ordering field." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." }, { "name": "filter_variable", "value": "frequency", "type": "query", "description": "Attribute to filter series results by." }, { "name": "filter_value", "value": "monthly", "type": "query", "description": "Value of the filter_variable attribute to match." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." } ] }, "docs": "Get economic data series that match keywords." }, { "info": { "name": "FRED Get the Tags for a Series Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/search/tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_search_text", "value": "monetary", "type": "query", "description": "Words to match against series titles." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "tag_search_text", "value": "usa", "type": "query", "description": "Words to match against tag names." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the FRED tags for a series search. Find tags that match the search text and are also assigned to series matching that search." }, { "info": { "name": "FRED Get the Related Tags for a Series Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/search/related_tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_search_text", "value": "monetary", "type": "query", "description": "Words to match against series titles." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "tag_search_text", "value": "usa", "type": "query", "description": "Words to match against tag names." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the related FRED tags for one or more FRED tags matching a series search." }, { "info": { "name": "FRED Get the Tags for an Economic Data Series", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_id", "value": "UNRATE", "type": "query", "description": "The FRED series ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the FRED tags for an economic data series." }, { "info": { "name": "FRED Get Economic Data Series Sorted by Last Updated Date", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/updates", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "filter_value", "value": "monthly", "type": "query", "description": "Filter results by audience." }, { "name": "start_time", "value": "202601010000", "type": "query", "description": "Lower bound for when a series was updated (YYYYMMDDHhmm)." }, { "name": "end_time", "value": "202605280000", "type": "query", "description": "Upper bound for when a series was updated (YYYYMMDDHhmm)." } ] }, "docs": "Get economic data series sorted by when observations were updated on the FRED server." }, { "info": { "name": "FRED Get the Dates in History When a Series Was Revised or Newly Released", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/vintagedates", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_id", "value": "UNRATE", "type": "query", "description": "The FRED series ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–10000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort by vintage_date." } ] }, "docs": "Get the dates in history when a series' data values were revised or new data values were released." } ] }, { "info": { "name": "Observations", "type": "folder" }, "items": [ { "info": { "name": "FRED Get the Observations or Data Values for an Economic Data Series", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/series/observations", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "series_id", "value": "UNRATE", "type": "query", "description": "The FRED series ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of observations to return (1–100000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort by observation_date." }, { "name": "observation_start", "value": "2020-01-01", "type": "query", "description": "Earliest observation date (YYYY-MM-DD)." }, { "name": "observation_end", "value": "2026-04-01", "type": "query", "description": "Latest observation date (YYYY-MM-DD)." }, { "name": "units", "value": "lin", "type": "query", "description": "Unit transformation applied to the data." }, { "name": "frequency", "value": "m", "type": "query", "description": "Frequency to aggregate the series to." }, { "name": "aggregation_method", "value": "avg", "type": "query", "description": "How to aggregate when a frequency is supplied." }, { "name": "output_type", "value": "1", "type": "query", "description": "Observations output type. 1=observations by real-time period" }, { "name": "vintage_dates", "value": "2024-01-15,2025-01-15", "type": "query", "description": "Comma-separated list of YYYY-MM-DD vintage dates." } ] }, "docs": "Get the observations or data values for an economic data series. Supports frequency aggregation and unit transformations." } ] }, { "info": { "name": "Sources", "type": "folder" }, "items": [ { "info": { "name": "FRED Get All Sources of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/sources", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Ordering field." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get all sources of economic data." }, { "info": { "name": "FRED Get a Source of Economic Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/source", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "source_id", "value": "1", "type": "query", "description": "Numeric source ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." } ] }, "docs": "Get a source of economic data by ID." }, { "info": { "name": "FRED Get the Releases for a Source", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/source/releases", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "source_id", "value": "1", "type": "query", "description": "Numeric source ID." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order release results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the releases for a source." } ] }, { "info": { "name": "Tags", "type": "folder" }, "items": [ { "info": { "name": "FRED Get FRED Tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against tag names and descriptions." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get FRED tags. Optionally filtered by tag names, group_id, or search text." }, { "info": { "name": "FRED Get the Related FRED Tags for One or More FRED Tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/related_tags", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." }, { "name": "tag_group_id", "value": "freq", "type": "query", "description": "Group identifier for tags — freq, gen, geo, geot, rls, seas, src." }, { "name": "search_text", "value": "monetary aggregates", "type": "query", "description": "Words to match against tag names and descriptions." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order tag results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the related FRED tags for one or more FRED tags. Related tags are tags assigned to series that also have all of the tag_names tags." }, { "info": { "name": "FRED Get the Series Matching All Tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.stlouisfed.org/fred/tags/series", "params": [ { "name": "api_key", "value": "abcdef0123456789abcdef0123456789", "type": "query", "description": "32-character lower-case alphanumeric FRED API key." }, { "name": "file_type", "value": "json", "type": "query", "description": "Response format. xml (default) or json. The observations endpoint additionally accepts xlsx and csv." }, { "name": "tag_names", "value": "monthly;usa", "type": "query", "description": "Semicolon-separated list of tag names to require." }, { "name": "exclude_tag_names", "value": "discontinued", "type": "query", "description": "Semicolon-separated list of tag names to exclude." }, { "name": "realtime_start", "value": "2026-05-28", "type": "query", "description": "Start of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "realtime_end", "value": "2026-05-28", "type": "query", "description": "End of the real-time period (YYYY-MM-DD). Defaults to today." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of results to return (1–1000)." }, { "name": "offset", "value": "0", "type": "query", "description": "Non-negative integer offset into the result set for pagination." }, { "name": "order_by", "value": "series_count", "type": "query", "description": "Field to order series results by." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "Sort order. asc (ascending, default) or desc (descending)." } ] }, "docs": "Get the series matching all of the supplied tags." } ] } ], "bundled": true }