fred-schema.yaml

openapi: 3.0.3
info:
  title: FRED API
  description: 'Federal Reserve Economic Data (FRED) web service, published by the Economic Research Division
    of the Federal Reserve Bank of St. Louis.


    The API exposes economic data series and the categories, releases, sources and tags that organise
    them, plus the regional data and GeoJSON shape files behind the FRED maps (the /geofred paths).


    Every request needs a free API key, passed as the api_key query parameter: https://fredaccount.stlouisfed.org/apikeys


    Responses are XML by default; set file_type=json for JSON.'
  version: 2.0.0
  contact:
    name: FRED API support
    url: https://fred.stlouisfed.org/docs/api/fred/
externalDocs:
  description: Official FRED API documentation
  url: https://fred.stlouisfed.org/docs/api/fred/
servers:
- url: https://api.stlouisfed.org
  description: FRED API server
security:
- ApiKeyAuth: []
tags:
- name: Categories
  description: Browse the category tree that organises FRED's series.
- name: Releases
  description: Data releases and their publication dates.
- name: Series
  description: Economic data series, their observations and metadata.
- name: Sources
  description: Organisations that publish the data FRED redistributes.
- name: Tags
  description: Free-form tags attached to series, releases and categories.
- name: Maps
  description: Regional data and GeoJSON shape files behind the FRED maps.
paths:
  /fred/category:
    get:
      tags:
      - Categories
      summary: Get a category.
      operationId: getCategory
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: category_id
        in: query
        description: The id for a category.
        schema:
          type: integer
          default: 0
          example: 125
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/category/children:
    get:
      tags:
      - Categories
      summary: Get the child categories for a specified parent category.
      operationId: getCategoryChildren
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: category_id
        in: query
        description: The id for a category.
        schema:
          type: integer
          default: 0
          example: 125
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/category/related:
    get:
      tags:
      - Categories
      summary: Get the related categories for a category.
      description: Get the related categories for a category. A related category is a one-way relation
        between 2 categories that is not part of a parent-child category hierarchy. Most categories do
        not have related categories.
      operationId: getCategoryRelated
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: category_id
        in: query
        required: true
        description: The id for a category.
        schema:
          type: integer
          example: 125
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/category/related_tags:
    get:
      tags:
      - Categories
      summary: Get the related FRED tags for one or more FRED tags within a category.
      description: Get the related FRED tags for one or more FRED tags within a category. Optionally,
        filter results by tag group or search.
      operationId: getCategoryRelatedTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: category_id
        in: query
        required: true
        description: The id for a category.
        schema:
          type: integer
          example: 125
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        required: true
        description: A semicolon delimited list of tag names that series match all of. See the related
          request fred/category/tags.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: monetary service index
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/category/series:
    get:
      tags:
      - Categories
      summary: Get the series in a category.
      operationId: getCategorySeries
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: category_id
        in: query
        required: true
        description: The id for a category.
        schema:
          type: integer
          example: 125
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_id
          - title
          - units
          - frequency
          - seasonal_adjustment
          - realtime_start
          - realtime_end
          - last_updated
          - observation_start
          - observation_end
          - popularity
          - group_popularity
          default: series_id
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: filter_variable
        in: query
        description: The attribute to filter results by. Use together with filter_value.
        schema:
          type: string
          example: frequency
      - name: filter_value
        in: query
        description: The value of the filter_variable attribute to filter results by.
        schema:
          type: string
          example: Monthly
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names that series match all of.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/category/tags:
    get:
      tags:
      - Categories
      summary: Get the FRED tags for a category.
      description: Get the FRED tags for a category. Optionally, filter results by tag name, tag group,
        or search. Series are assigned tags and categories. Indirectly through series, it is possible
        to get the tags for a category. No tags exist for a category that does not have series. See the
        related request fred/category/related_tags.
      operationId: getCategoryTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: category_id
        in: query
        required: true
        description: The id for a category.
        schema:
          type: integer
          example: 125
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names to only include in the response. See the
          related request fred/category/related_tags.
        schema:
          type: string
          example: services;quarterly
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: monetary service index
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /geofred/regional/data:
    get:
      tags:
      - Maps
      summary: This request returns a cross section of regional data.
      operationId: getGeoFredRegionalData
      parameters:
      - name: file_type
        in: query
        description: A key or file extension that indicates the type of file to send.
        schema:
          type: string
          enum:
          - xml
          - json
      - name: series_group
        in: query
        required: true
        description: The ID for a group of series found in FRED.
        schema:
          type: string
          example: '882'
      - name: region_type
        in: query
        required: true
        description: The region you want to pull data for.
        schema:
          type: string
          example: state
      - name: date
        in: query
        required: true
        description: The date you want to pull a series group data from.
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: start_date
        in: query
        description: The start date you want to request series group data from. This allows you to pull
          a range of data
        schema:
          type: string
          format: date
          example: '2012-01-01'
      - name: season
        in: query
        required: true
        description: The seasonality of the series group.
        schema:
          type: string
          example: NSA
      - name: units
        in: query
        required: true
        description: The units of the series you want to pull.
        schema:
          type: string
          example: Dollars
      - name: transformation
        in: query
        description: 'A key that indicates a data value transformation. Values: lin = Levels (No transformation);
          chg = Change; ch1 = Change from Year Ago; pch = Percent Change; pc1 = Percent Change from Year
          Ago; pca = Compounded Annual Rate of Change; cch = Continuously Compounded Rate of Change; cca
          = Continuously Compounded Annual Rate of Change; log = Natural Log.'
        schema:
          type: string
          enum:
          - lin
          - chg
          - ch1
          - pch
          - pc1
          - pca
          - cch
          - cca
          - log
          default: lin
      - name: frequency
        in: query
        required: true
        description: 'Frequency automatically assigns the default frequency of the map when using the
          Request Wizard above. The parameter can be used as a frequency aggregation feature. The maps
          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 maps, 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. Values: d
          = Daily; w = Weekly; bw = Biweekly; m = Monthly; q = Quarterly; sa = Semiannual; a = Annual;
          wef = Weekly, Ending Friday; weth = Weekly, Ending Thursday; wew = Weekly, Ending Wednesday;
          wetu = Weekly, Ending Tuesday; wem = Weekly, Ending Monday; wesu = Weekly, Ending Sunday; wesa
          = Weekly, Ending Saturday; bwew = Biweekly, Ending Wednesday; bwem = Biweekly, Ending Monday.'
        schema:
          type: string
          enum:
          - d
          - w
          - bw
          - m
          - q
          - sa
          - a
          - wef
          - weth
          - wew
          - wetu
          - wem
          - wesu
          - wesa
          - bwew
          - bwem
          example: a
      - name: aggregation_method
        in: query
        schema:
          type: string
          enum:
          - avg
          - sum
          - eop
          default: avg
        description: 'Has no effect unless frequency is set. Values: avg = Average; sum = Sum; eop = End
          of Period.'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /geofred/series/data:
    get:
      tags:
      - Maps
      summary: This request returns a cross section of regional data for a specified release date.
      description: This request returns a cross section of regional data for a specified release date.
        If no date is specified, the most recent data available are returned.
      operationId: getGeoFredSeriesData
      parameters:
      - name: file_type
        in: query
        description: A key or file extension that indicates the type of file to send.
        schema:
          type: string
          enum:
          - xml
          - json
      - name: series_id
        in: query
        required: true
        description: The FRED series_id you want to request maps data for. Not all series that are in
          FRED have geographical data.
        schema:
          type: string
          example: GNPCA
      - name: date
        in: query
        description: The date you want to request series group data from.
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: start_date
        in: query
        description: The start date you want to request series group data from. This allows you to pull
          a range of data
        schema:
          type: string
          format: date
          example: '2012-01-01'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /geofred/series/group:
    get:
      tags:
      - Maps
      summary: This request returns the meta information needed to make requests for FRED data.
      description: This request returns the meta information needed to make requests for FRED data. Minimum
        and maximum date are also supplied for the data range available.
      operationId: getGeoFredSeriesGroup
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
      - name: series_id
        in: query
        required: true
        description: The FRED series id you want to request maps meta information for. Not all series
          that are in FRED have geographical data.
        schema:
          type: string
          example: GNPCA
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /geofred/shapes/file:
    get:
      tags:
      - Maps
      summary: This request returns shape files from FRED in GeoJSON format.
      operationId: getGeoFredShapesFile
      parameters:
      - name: shape
        in: query
        required: true
        description: The type of shape you want to pull GeoJSON data for.
        schema:
          type: string
          enum:
          - bea
          - msa
          - frb
          - necta
          - state
          - country
          - county
          - censusregion
          - censusdivision
          example: bea
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release:
    get:
      tags:
      - Releases
      summary: Get a release of economic data.
      operationId: getRelease
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release/dates:
    get:
      tags:
      - Releases
      summary: Get release dates for a release of economic data.
      operationId: getReleaseDates
      parameters:
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Together with realtime_end this selects the vintage of the data: leaving both at their defaults
          returns the data as it stands today, while an earlier period returns the figures as they were
          then.'
        schema:
          type: string
          format: date
          default: '1776-07-04'
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: The end of the real-time period. For more information, see Real-Time Periods. See
          realtime_start.
        schema:
          type: string
          format: date
          default: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
          default: 10000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: sort_order
        in: query
        description: Sort results is ascending or descending release date order.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: include_release_dates_with_no_data
        in: query
        description: Determines whether release dates with no data available are returned. The defalut
          value 'false' excludes release dates that do not have data. In particular, this excludes future
          release dates which may be available in the FRED release calendar or the ALFRED release calendar.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
          default: 'false'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release/related_tags:
    get:
      tags:
      - Releases
      summary: Get the related FRED tags for one or more FRED tags within a release.
      description: Get the related FRED tags for one or more FRED tags within a release. Optionally, filter
        results by tag group or search.
      operationId: getReleaseRelatedTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        required: true
        description: A semicolon delimited list of tag names that series match all of. See the related
          request fred/release/tags.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: monetary service index
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release/series:
    get:
      tags:
      - Releases
      summary: Get the series on a release of economic data.
      operationId: getReleaseSeries
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_id
          - title
          - units
          - frequency
          - seasonal_adjustment
          - realtime_start
          - realtime_end
          - last_updated
          - observation_start
          - observation_end
          - popularity
          - group_popularity
          default: series_id
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: filter_variable
        in: query
        description: The attribute to filter results by. Use together with filter_value.
        schema:
          type: string
          enum:
          - frequency
          - units
          - seasonal_adjustment
          example: frequency
      - name: filter_value
        in: query
        description: The value of the filter_variable attribute to filter results by.
        schema:
          type: string
          example: Monthly
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names that series match all of.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release/sources:
    get:
      tags:
      - Releases
      summary: Get the sources for a release of economic data.
      operationId: getReleaseSources
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release/tables:
    get:
      tags:
      - Releases
      summary: Get release table trees for a given release.
      description: Get release table trees for a given release. You can go directly to the tree structure
        by passing the appropriate element_id. You may also use a drill-down approach to start at the
        root (top most) element by leaving the element_id off.
      operationId: getReleaseTables
      parameters:
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: element_id
        in: query
        description: The release table element id you would like to retrieve.
        schema:
          type: integer
          example: 12886
      - name: include_observation_values
        in: query
        description: A flag to indicate that observations need to be returned. Observation value and date
          will only be returned for a series type element.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
          default: 'false'
      - name: observation_date
        in: query
        description: The observation date to be included with the returned release table.
        schema:
          type: string
          format: date
          default: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/release/tags:
    get:
      tags:
      - Releases
      summary: Get the FRED tags for a release.
      description: Get the FRED tags for a release. Optionally, filter results by tag name, tag group,
        or search. Series are assigned tags and releases. Indirectly through series, it is possible to
        get the tags for a release. See the related request fred/release/related_tags.
      operationId: getReleaseTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: release_id
        in: query
        required: true
        description: The id for a release.
        schema:
          type: integer
          example: 53
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names to only include in the response. See the
          related request fred/release/related_tags.
        schema:
          type: string
          example: services;quarterly
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: monetary service index
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/releases:
    get:
      tags:
      - Releases
      summary: Get all releases of economic data.
      operationId: getReleases
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - release_id
          - name
          - press_release
          - realtime_start
          - realtime_end
          default: release_id
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/releases/dates:
    get:
      tags:
      - Releases
      summary: Get release dates for all releases of economic data.
      operationId: getReleasesDates
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: First day of the current year. Together with realtime_end this selects the vintage
          of the data: leaving both at their defaults returns the data as it stands today, while an earlier
          period returns the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: The end of the real-time period. For more information, see Real-Time Periods. See
          realtime_start.
        schema:
          type: string
          format: date
          default: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - release_date
          - release_id
          - release_name
          default: release_date
      - name: sort_order
        in: query
        description: Sort results is ascending or descending release date order.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      - name: include_release_dates_with_no_data
        in: query
        description: Determines whether release dates with no data available are returned. The defalut
          value 'false' excludes release dates that do not have data. In particular, this excludes future
          release dates which may be available in the FRED release calendar or the ALFRED release calendar.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
          default: 'false'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series:
    get:
      tags:
      - Series
      summary: Get an economic data series.
      operationId: getSeries
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_id
        in: query
        required: true
        description: The id for a series.
        schema:
          type: string
          example: GNPCA
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/categories:
    get:
      tags:
      - Series
      summary: Get the categories for an economic data series.
      operationId: getSeriesCategories
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_id
        in: query
        required: true
        description: The id for a series.
        schema:
          type: string
          example: GNPCA
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/observations:
    get:
      tags:
      - Series
      summary: Get the observations or data values for an economic data series.
      operationId: getSeriesObservations
      parameters:
      - name: file_type
        in: query
        description: A key or file extension that indicates the type of file to send.
        schema:
          type: string
          enum:
          - xml
          - json
          - xlsx
          - csv
          default: xml
      - name: series_id
        in: query
        required: true
        description: The id for a series.
        schema:
          type: string
          example: GNPCA
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods,
          vintage_dates. Default: today''s date. Together with realtime_end this selects the vintage of
          the data: leaving both at their defaults returns the data as it stands today, while an earlier
          period returns the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods, vintage_dates.
          Default: today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 100000
          default: 100000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: sort_order
        in: query
        description: Sort results is ascending or descending observation_date order.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: observation_start
        in: query
        description: The start of the observation period.
        schema:
          type: string
          format: date
          default: '1776-07-04'
          example: '2000-01-01'
      - name: observation_end
        in: query
        description: The end of the observation period.
        schema:
          type: string
          format: date
          default: '9999-12-31'
          example: '2020-12-31'
      - name: units
        in: query
        description: 'A key that indicates a data value transformation. Values: lin = Levels (No transformation);
          chg = Change; ch1 = Change from Year Ago; pch = Percent Change; pc1 = Percent Change from Year
          Ago; pca = Compounded Annual Rate of Change; cch = Continuously Compounded Rate of Change; cca
          = Continuously Compounded Annual Rate of Change; log = Natural Log.'
        schema:
          type: string
          enum:
          - lin
          - chg
          - ch1
          - pch
          - pc1
          - pca
          - cch
          - cca
          - log
          default: lin
      - name: frequency
        in: query
        description: '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. Default: no
          value for no frequency aggregation. Note that an error will be returned if a frequency is specified
          that is higher than the native frequency of the series. Values: d = Daily; w = Weekly; bw =
          Biweekly; m = Monthly; q = Quarterly; sa = Semiannual; a = Annual; wef = Weekly, Ending Friday;
          weth = Weekly, Ending Thursday; wew = Weekly, Ending Wednesday; wetu = Weekly, Ending Tuesday;
          wem = Weekly, Ending Monday; wesu = Weekly, Ending Sunday; wesa = Weekly, Ending Saturday; bwew
          = Biweekly, Ending Wednesday; bwem = Biweekly, Ending Monday.'
        schema:
          type: string
          enum:
          - d
          - w
          - bw
          - m
          - q
          - sa
          - a
          - wef
          - weth
          - wew
          - wetu
          - wem
          - wesu
          - wesa
          - bwew
          - bwem
          example: a
      - name: aggregation_method
        in: query
        description: 'A key that indicates the aggregation method used for frequency aggregation. This
          parameter has no affect if the frequency parameter is not set. Has no effect unless frequency
          is set. Values: avg = Average; sum = Sum; eop = End of Period.'
        schema:
          type: string
          enum:
          - avg
          - sum
          - eop
          default: avg
      - name: output_type
        in: query
        description: 'An integer that indicates an output type. Values: 1 = Observations by Real-Time
          Period; 2 = Observations by Vintage Date, All Observations; 3 = Observations by Vintage Date,
          New and Revised Observations Only; 4 = Observations, Initial Release Only.'
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          default: 1
      - name: vintage_dates
        in: query
        description: A comma separated string of YYYY-MM-DD formatted dates in history (e.g. 2000-01-01,2005-02-24).
          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.
        schema:
          type: string
          example: 2000-01-01,2005-02-24
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/release:
    get:
      tags:
      - Series
      summary: Get the release for an economic data series.
      operationId: getSeriesRelease
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_id
        in: query
        required: true
        description: The id for a series.
        schema:
          type: string
          example: GNPCA
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/search:
    get:
      tags:
      - Series
      summary: Get economic data series that match search text.
      operationId: getSeriesSearch
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: search_text
        in: query
        description: The words to match against economic data series.
        schema:
          type: string
          example: monetary service index
      - name: search_type
        in: query
        description: Determines the type of search to perform.
        schema:
          type: string
          enum:
          - full_text
          - series_id
          default: full_text
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: 'Order results by values of the specified attribute. Default: If the value of search_type
          is ''full_text'' then the default value of order_by is ''search_rank''. If the value of search_type
          is ''series_id'' then the default value of order_by is ''series_id''.'
        schema:
          type: string
          enum:
          - search_rank
          - series_id
          - title
          - units
          - frequency
          - seasonal_adjustment
          - realtime_start
          - realtime_end
          - last_updated
          - observation_start
          - observation_end
          - popularity
          - group_popularity
      - name: sort_order
        in: query
        description: 'Sort results is ascending or descending order for attribute values specified by
          order_by. Default: If order_by is equal to ''search_rank'' or ''popularity'', then the default
          value of sort_order is ''desc''. Otherwise, the default sort order is ''asc''.'
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: filter_variable
        in: query
        description: The attribute to filter results by. Use together with filter_value.
        schema:
          type: string
          enum:
          - frequency
          - units
          - seasonal_adjustment
          example: frequency
      - name: filter_value
        in: query
        description: The value of the filter_variable attribute to filter results by.
        schema:
          type: string
          example: Monthly
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names that series match all of.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/search/related_tags:
    get:
      tags:
      - Series
      summary: Get the related FRED tags for one or more FRED tags matching a series search.
      description: Get the related FRED tags for one or more FRED tags matching a series search. Optionally,
        filter results by tag group or tag search.
      operationId: getSeriesSearchRelatedTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_search_text
        in: query
        required: true
        description: The words to match against economic data series.
        schema:
          type: string
          example: mortgage rate
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        required: true
        description: A semicolon delimited list of tag names that series match all of. See the related
          request fred/series/search/tags.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: tag_search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: gdp
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/search/tags:
    get:
      tags:
      - Series
      summary: Get the FRED tags for a series search.
      description: Get the FRED tags for a series search. Optionally, filter results by tag name, tag
        group, or tag search. See the related request fred/series/search/related_tags.
      operationId: getSeriesSearchTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_search_text
        in: query
        required: true
        description: The words to match against economic data series.
        schema:
          type: string
          example: mortgage rate
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names to only include in the response. See the
          related request fred/series/search/related_tags.
        schema:
          type: string
          example: services;quarterly
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: tag_search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: gdp
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/tags:
    get:
      tags:
      - Series
      summary: Get the FRED tags for a series.
      operationId: getSeriesTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_id
        in: query
        required: true
        description: The id for a series.
        schema:
          type: string
          example: GNPCA
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/updates:
    get:
      tags:
      - Series
      summary: Get economic data series sorted by when observations were updated on the FRED® server (attribute
        last_updated).
      description: Get economic data series sorted by when observations were updated on the FRED® server
        (attribute last_updated). Results are limited to series updated within the last two weeks.
      operationId: getSeriesUpdates
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: filter_value
        in: query
        description: Limit results by geographic type of economic data series; namely 'macro', 'regional',
          and 'all'.
        schema:
          type: string
          default: all
          example: Monthly
      - name: start_time
        in: query
        description: Start time for limiting results for a time range, can filter down to minutes Required
          if end_time is set.
        schema:
          type: string
          example: '201803021420'
      - name: end_time
        in: query
        description: End time for limiting results for a time range, can filter down to minutes Required
          if start_time is set.
        schema:
          type: string
          example: '201803021430'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/series/vintagedates:
    get:
      tags:
      - Series
      summary: Get the dates in history when a series' data values were revised or new data values were
        released.
      description: Get the dates in history when a series' data values were revised or new data values
        were released. Vintage dates are the release dates for a series excluding release dates when the
        data for the series did not change.
      operationId: getSeriesVintagedates
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: series_id
        in: query
        required: true
        description: The id for a series.
        schema:
          type: string
          example: GNPCA
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Together with realtime_end this selects the vintage of the data: leaving both at their defaults
          returns the data as it stands today, while an earlier period returns the figures as they were
          then.'
        schema:
          type: string
          format: date
          default: '1776-07-04'
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: The end of the real-time period. For more information, see Real-Time Periods. See
          realtime_start.
        schema:
          type: string
          format: date
          default: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 10000
          default: 10000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: sort_order
        in: query
        description: Sort results is ascending or descending vintage_date order.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/source:
    get:
      tags:
      - Sources
      summary: Get a source of economic data.
      operationId: getSource
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: source_id
        in: query
        required: true
        description: The id for a source.
        schema:
          type: integer
          example: 1
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/source/releases:
    get:
      tags:
      - Sources
      summary: Get the releases for a source.
      operationId: getSourceReleases
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: source_id
        in: query
        required: true
        description: The id for a source.
        schema:
          type: integer
          example: 1
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - release_id
          - name
          - press_release
          - realtime_start
          - realtime_end
          default: release_id
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/sources:
    get:
      tags:
      - Sources
      summary: Get all sources of economic data.
      operationId: getSources
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - source_id
          - name
          - realtime_start
          - realtime_end
          default: source_id
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/related_tags:
    get:
      tags:
      - Tags
      summary: Get the related FRED tags for one or more FRED tags.
      description: Get the related FRED tags for one or more FRED tags. Optionally, filter results by
        tag group or search.
      operationId: getRelatedTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        required: true
        description: A semicolon delimited list of tag names that series match all of. See the related
          request fred/tags.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: monetary service index
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/tags:
    get:
      tags:
      - Tags
      summary: Get FRED tags.
      description: 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.
      operationId: getTags
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: tag_names
        in: query
        description: A semicolon delimited list of tag names to only include in the response. See the
          related request fred/related_tags.
        schema:
          type: string
          example: services;quarterly
      - name: tag_group_id
        in: query
        description: A tag group id to filter tags by type.
        schema:
          type: string
          example: geo
      - name: search_text
        in: query
        description: The words to find matching tags with.
        schema:
          type: string
          example: monetary service index
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_count
          - popularity
          - created
          - name
          - group_id
          default: series_count
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /fred/tags/series:
    get:
      tags:
      - Tags
      summary: Get the series matching all tags in the tag_names parameter and no tags in the exclude_tag_names
        parameter.
      operationId: getTagsSeries
      parameters:
      - name: file_type
        in: query
        description: 'A key or file extension that indicates the type of file to send. Values: xml = Extensible
          Markup Language. The HTTP Content-Type is text/xml; json = JavaScript Object Notation. The HTTP
          Content-Type is application/json.'
        schema:
          type: string
          enum:
          - xml
          - json
          default: xml
      - name: tag_names
        in: query
        required: true
        description: A semicolon delimited list of tag names that series match all of.
        schema:
          type: string
          example: services;quarterly
      - name: exclude_tag_names
        in: query
        description: A semicolon delimited list of tag names that series match none of.
        schema:
          type: string
          example: discontinued;annual
      - name: realtime_start
        in: query
        description: 'The start of the real-time period. For more information, see Real-Time Periods.
          Default: today''s date. Together with realtime_end this selects the vintage of the data: leaving
          both at their defaults returns the data as it stands today, while an earlier period returns
          the figures as they were then.'
        schema:
          type: string
          format: date
          example: '2013-01-01'
      - name: realtime_end
        in: query
        description: 'The end of the real-time period. For more information, see Real-Time Periods. Default:
          today''s date. See realtime_start.'
        schema:
          type: string
          format: date
          example: '9999-12-31'
      - name: limit
        in: query
        description: The maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 1000
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
        description: Number of results to skip before the first row returned. Combine with limit to page
          through a result set.
      - name: order_by
        in: query
        description: Order results by values of the specified attribute.
        schema:
          type: string
          enum:
          - series_id
          - title
          - units
          - frequency
          - seasonal_adjustment
          - realtime_start
          - realtime_end
          - last_updated
          - observation_start
          - observation_end
          - popularity
          - group_popularity
          default: series_id
      - name: sort_order
        in: query
        description: Sort results is ascending or descending order for attribute values specified by order_by.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
            text/xml:
              schema:
                type: string
        '400':
          description: 'Bad request: a parameter is missing, malformed or out of range, or the API key
            was rejected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: api_key
      description: 32 character lower-case alphanumeric API key. Register for one at https://fredaccount.stlouisfed.org/apikeys
  schemas:
    Error:
      type: object
      properties:
        error_code:
          type: integer
          example: 400
        error_message:
          type: string
          example: Bad Request.  The category does not exist.