CFPB HMDA Data Browser API — Aggregations

naftiko: 1.0.0-alpha2
info:
  label: CFPB HMDA Data Browser API — Aggregations
  description: 'CFPB HMDA Data Browser API — Aggregations. 2 operations. Lead operation: Aggregation report by LEI or geography.
    Self-contained Naftiko capability covering one Consumer Financial Protection Bureau business surface.'
  tags:
  - Consumer Financial Protection Bureau
  - Aggregations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CONSUMER_FINANCIAL_PROTECTION_BUREAU_API_KEY: CONSUMER_FINANCIAL_PROTECTION_BUREAU_API_KEY
capability:
  consumes:
  - type: http
    namespace: cfpb-hmda-data-browser-aggregations
    baseUri: https://ffiec.cfpb.gov/v2/data-browser-api
    description: CFPB HMDA Data Browser API — Aggregations business capability. Self-contained, no shared references.
    resources:
    - name: view-aggregations
      path: /view/aggregations
      operations:
      - name: getaggregations
        method: GET
        description: Aggregation report by LEI or geography
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: leis
          in: query
          type: array
        - name: states
          in: query
          type: array
        - name: msamds
          in: query
          type: array
        - name: counties
          in: query
          type: array
    - name: view-nationwide-aggregations
      path: /view/nationwide/aggregations
      operations:
      - name: getnationwideaggregations
        method: GET
        description: Nationwide aggregation report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: cfpb-hmda-data-browser-aggregations-rest
    port: 8080
    description: REST adapter for CFPB HMDA Data Browser API — Aggregations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/view/aggregations
      name: view-aggregations
      description: REST surface for view-aggregations.
      operations:
      - method: GET
        name: getaggregations
        description: Aggregation report by LEI or geography
        call: cfpb-hmda-data-browser-aggregations.getaggregations
        with:
          leis: rest.leis
          states: rest.states
          msamds: rest.msamds
          counties: rest.counties
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/view/nationwide/aggregations
      name: view-nationwide-aggregations
      description: REST surface for view-nationwide-aggregations.
      operations:
      - method: GET
        name: getnationwideaggregations
        description: Nationwide aggregation report
        call: cfpb-hmda-data-browser-aggregations.getnationwideaggregations
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cfpb-hmda-data-browser-aggregations-mcp
    port: 9090
    transport: http
    description: MCP adapter for CFPB HMDA Data Browser API — Aggregations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: aggregation-report-lei-geography
      description: Aggregation report by LEI or geography
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cfpb-hmda-data-browser-aggregations.getaggregations
      with:
        leis: tools.leis
        states: tools.states
        msamds: tools.msamds
        counties: tools.counties
      outputParameters:
      - type: object
        mapping: $.
    - name: nationwide-aggregation-report
      description: Nationwide aggregation report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cfpb-hmda-data-browser-aggregations.getnationwideaggregations
      outputParameters:
      - type: object
        mapping: $.