FRED Maps API (GeoFRED) — Regional Data

naftiko: 1.0.0-alpha2
info:
  label: FRED Maps API (GeoFRED) — Regional Data
  description: 'FRED Maps API (GeoFRED) — Regional Data. 1 operations. Lead operation: FRED Get Regional Data by Series Group. Self-contained Naftiko capability covering one FRED business surface.'
  tags:
    - FRED
    - FRED Maps
    - Regional Data
  created: '2026-05-28'
  modified: '2026-05-28'
binds:
  - namespace: env
    keys:
      FRED_API_KEY: FRED_API_KEY
capability:
  consumes:
    - type: http
      namespace: geofred-regional-data
      baseUri: https://api.stlouisfed.org/geofred
      description: FRED Maps API (GeoFRED) — Regional Data business capability. Self-contained, no shared references.
      authentication:
        type: apikey
        key: api_key
        value: '{{env.FRED_API_KEY}}'
        placement: query
      resources:
        - name: regional-data
          path: /regional/data
          operations:
            - name: getRegionalData
              method: GET
              description: FRED Get Regional Data by Series Group
              inputParameters:
                - name: api_key
                  in: query
                  type: string
                  required: true
                  description: 32-character lower-case alphanumeric FRED API key.
                - name: file_type
                  in: query
                  type: string
                  required: false
                  description: Response format — json or xml.
                - name: series_group
                  in: query
                  type: string
                  required: true
                  description: ID for a group of series found in FRED.
                - name: region_type
                  in: query
                  type: string
                  required: true
                  description: Geography to pull data for.
                - name: date
                  in: query
                  type: string
                  required: true
                  description: Date you want data from (YYYY-MM-DD).
                - name: start_date
                  in: query
                  type: string
                  required: false
                  description: Optional start date for a range query.
                - name: season
                  in: query
                  type: string
                  required: true
                  description: Seasonal-adjustment treatment.
                - name: units
                  in: query
                  type: string
                  required: true
                  description: Units of the series you want to pull (e.g. Dollars
                - name: frequency
                  in: query
                  type: string
                  required: true
                  description: Data frequency code.
                - name: transformation
                  in: query
                  type: string
                  required: false
                  description: Unit transformation applied to the data.
                - name: aggregation_method
                  in: query
                  type: string
                  required: false
                  description: Method used to aggregate values when frequency is supplied.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
  exposes:
    - type: rest
      namespace: geofred-regional-data-rest
      port: 8080
      description: REST adapter for FRED Maps API (GeoFRED) — Regional Data. One Spectral-compliant resource per consumed operation, prefixed with /v1.
      resources:
        - path: /v1/regional/data
          name: regional-data
          description: REST surface for /regional/data.
          operations:
            - method: GET
              name: getRegionalData
              description: FRED Get Regional Data by Series Group
              call: geofred-regional-data.getRegionalData
              with:
                api_key: rest.api_key
                file_type: rest.file_type
                series_group: rest.series_group
                region_type: rest.region_type
                date: rest.date
                start_date: rest.start_date
                season: rest.season
                units: rest.units
                frequency: rest.frequency
                transformation: rest.transformation
                aggregation_method: rest.aggregation_method
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: geofred-regional-data-mcp
      port: 9090
      transport: http
      description: MCP adapter for FRED Maps API (GeoFRED) — Regional Data. One tool per consumed operation, routed inline through this capability's consumes block.
      tools:
        - name: get-regional-data-series-group
          description: FRED Get Regional Data by Series Group
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: geofred-regional-data.getRegionalData
          with:
            api_key: tools.api_key
            file_type: tools.file_type
            series_group: tools.series_group
            region_type: tools.region_type
            date: tools.date
            start_date: tools.start_date
            season: tools.season
            units: tools.units
            frequency: tools.frequency
            transformation: tools.transformation
            aggregation_method: tools.aggregation_method
          outputParameters:
            - type: object
              mapping: $.