ATTOM Property API — School

naftiko: 1.0.0-alpha2
info:
  label: ATTOM Property API — School
  description: 'ATTOM School — school and school-district assignments for a property. Self-contained Naftiko
    capability covering one ATTOM business surface.'
  tags:
  - ATTOM
  - School
  - Education
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    ATTOM_API_KEY: ATTOM_API_KEY
capability:
  consumes:
  - type: http
    namespace: property-school
    baseUri: https://api.gateway.attomdata.com
    description: ATTOM Property — School business capability.
    resources:
    - name: school-snapshot
      path: /propertyapi/v1.0.0/school/snapshot
      operations:
      - name: getschoolsnapshot
        method: GET
        description: ATTOM Get School Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AttomID
          in: query
          type: string
          required: false
        - name: address
          in: query
          type: string
          required: false
    - name: property-detail-with-schools
      path: /propertyapi/v1.0.0/property/detailwithschools
      operations:
      - name: getpropertydetailwithschools
        method: GET
        description: ATTOM Get Property Detail With Schools
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AttomID
          in: query
          type: string
          required: false
        - name: address
          in: query
          type: string
          required: false
    authentication:
      type: apikey
      key: apikey
      value: '{{env.ATTOM_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: property-school-rest
    port: 8080
    description: REST adapter for ATTOM Property — School.
    resources:
    - path: /v1/school/snapshot
      name: school-snapshot
      operations:
      - method: GET
        name: getschoolsnapshot
        description: ATTOM Get School Snapshot
        call: property-school.getschoolsnapshot
        with:
          AttomID: rest.query.AttomID
          address: rest.query.address
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/property/detailwithschools
      name: property-detail-with-schools
      operations:
      - method: GET
        name: getpropertydetailwithschools
        description: ATTOM Get Property Detail With Schools
        call: property-school.getpropertydetailwithschools
        with:
          AttomID: rest.query.AttomID
          address: rest.query.address
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: property-school-mcp
    port: 9090
    transport: http
    description: MCP adapter for ATTOM Property — School.
    tools:
    - name: attom-get-school-snapshot
      description: ATTOM Get School Snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: property-school.getschoolsnapshot
      with:
        AttomID: tools.AttomID
        address: tools.address
      outputParameters:
      - type: object
        mapping: $.
    - name: attom-get-property-detail-with-schools
      description: ATTOM Get Property Detail With Schools
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: property-school.getpropertydetailwithschools
      with:
        AttomID: tools.AttomID
        address: tools.address
      outputParameters:
      - type: object
        mapping: $.