ATTOM Area API — Area

naftiko: 1.0.0-alpha2
info:
  label: ATTOM Area API — Area
  description: 'ATTOM Area — boundary, hierarchy, and lookup for U.S. states, counties, CBSAs, neighborhoods,
    and ZIPs. Self-contained Naftiko capability covering one ATTOM business surface.'
  tags:
  - ATTOM
  - Area
  - Geography
  - Boundary
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    ATTOM_API_KEY: ATTOM_API_KEY
capability:
  consumes:
  - type: http
    namespace: area-area
    baseUri: https://api.gateway.attomdata.com
    description: ATTOM Area — Area business capability.
    resources:
    - name: boundary-detail
      path: /areaapi/area/boundary/detail
      operations:
      - name: getboundarydetail
        method: GET
        description: ATTOM Get Boundary Detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: geoIdV4
          in: query
          type: string
          required: true
        - name: format
          in: query
          type: string
          required: false
    - name: hierarchy-lookup
      path: /areaapi/area/hierarchy/lookup
      operations:
      - name: gethierarchylookup
        method: GET
        description: ATTOM Lookup Geographic Hierarchy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: latitude
          in: query
          type: number
          required: true
        - name: longitude
          in: query
          type: number
          required: true
    - name: county-lookup
      path: /areaapi/area/county/lookup
      operations:
      - name: getcountylookup
        method: GET
        description: ATTOM Lookup Counties By State
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: stateId
          in: query
          type: string
          required: true
    - name: location-lookup-v4
      path: /v4/location/lookup
      operations:
      - name: getlocationlookupv4
        method: GET
        description: ATTOM Lookup Location By GeoIdV4
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: geoidv4
          in: query
          type: string
          required: false
        - name: geographyTypeAbbreviation
          in: query
          type: string
          required: false
    authentication:
      type: apikey
      key: apikey
      value: '{{env.ATTOM_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: area-area-rest
    port: 8080
    description: REST adapter for ATTOM Area.
    resources:
    - path: /v1/area/boundary/detail
      name: boundary-detail
      operations:
      - method: GET
        name: getboundarydetail
        description: ATTOM Get Boundary Detail
        call: area-area.getboundarydetail
        with:
          geoIdV4: rest.query.geoIdV4
          format: rest.query.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/area/hierarchy/lookup
      name: hierarchy-lookup
      operations:
      - method: GET
        name: gethierarchylookup
        description: ATTOM Lookup Geographic Hierarchy
        call: area-area.gethierarchylookup
        with:
          latitude: rest.query.latitude
          longitude: rest.query.longitude
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/area/county/lookup
      name: county-lookup
      operations:
      - method: GET
        name: getcountylookup
        description: ATTOM Lookup Counties By State
        call: area-area.getcountylookup
        with:
          stateId: rest.query.stateId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/location/lookup
      name: location-lookup-v4
      operations:
      - method: GET
        name: getlocationlookupv4
        description: ATTOM Lookup Location By GeoIdV4
        call: area-area.getlocationlookupv4
        with:
          geoidv4: rest.query.geoidv4
          geographyTypeAbbreviation: rest.query.geographyTypeAbbreviation
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: area-area-mcp
    port: 9090
    transport: http
    description: MCP adapter for ATTOM Area.
    tools:
    - name: attom-get-boundary-detail
      description: ATTOM Get Boundary Detail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: area-area.getboundarydetail
      with:
        geoIdV4: tools.geoIdV4
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: attom-get-hierarchy-lookup
      description: ATTOM Lookup Geographic Hierarchy
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: area-area.gethierarchylookup
      with:
        latitude: tools.latitude
        longitude: tools.longitude
      outputParameters:
      - type: object
        mapping: $.
    - name: attom-get-county-lookup
      description: ATTOM Lookup Counties By State
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: area-area.getcountylookup
      with:
        stateId: tools.stateId
      outputParameters:
      - type: object
        mapping: $.
    - name: attom-get-location-lookup-v4
      description: ATTOM Lookup Location By GeoIdV4
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: area-area.getlocationlookupv4
      with:
        geoidv4: tools.geoidv4
        geographyTypeAbbreviation: tools.geographyTypeAbbreviation
      outputParameters:
      - type: object
        mapping: $.