PostalCodes.info Postal Code Reference API — Search

naftiko: 1.0.0-alpha2
info:
  label: PostalCodes.info Postal Code Reference API — Search
  description: 'PostalCodes.info Postal Code Reference API — Search. 2 operations. Lead operation: Preview Records for One
    Country. Self-contained Naftiko capability covering one Postalcodes Info business surface.'
  tags:
  - Postalcodes Info
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POSTALCODES_INFO_API_KEY: POSTALCODES_INFO_API_KEY
capability:
  consumes:
  - type: http
    namespace: postalcodes-info-search
    baseUri: https://postalcodes.info
    description: PostalCodes.info Postal Code Reference API — Search business capability. Self-contained, no shared references.
    resources:
    - name: ajax-preview
      path: /ajax-preview
      operations:
      - name: previewcountryrecords
        method: GET
        description: Preview Records for One Country
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: country
          in: query
          type: string
          description: Country slug such as spain, united-states or india.
          required: true
    - name: search
      path: /search
      operations:
      - name: searchpostalcodes
        method: GET
        description: Search Postal Codes, Places or Countries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: Search term. Minimum 2 characters.
          required: true
        - name: country
          in: query
          type: string
          description: Optional ISO 3166-1 alpha-2 country code filter.
        - name: region
          in: query
          type: string
          description: Optional region text filter.
  exposes:
  - type: rest
    namespace: postalcodes-info-search-rest
    port: 8080
    description: REST adapter for PostalCodes.info Postal Code Reference API — Search. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/ajax-preview
      name: ajax-preview
      description: REST surface for ajax-preview.
      operations:
      - method: GET
        name: previewcountryrecords
        description: Preview Records for One Country
        call: postalcodes-info-search.previewcountryrecords
        with:
          country: rest.country
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search
      name: search
      description: REST surface for search.
      operations:
      - method: GET
        name: searchpostalcodes
        description: Search Postal Codes, Places or Countries
        call: postalcodes-info-search.searchpostalcodes
        with:
          q: rest.q
          country: rest.country
          region: rest.region
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: postalcodes-info-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for PostalCodes.info Postal Code Reference API — Search. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: preview-records-one-country
      description: Preview Records for One Country
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: postalcodes-info-search.previewcountryrecords
      with:
        country: tools.country
      outputParameters:
      - type: object
        mapping: $.
    - name: search-postal-codes-places-countries
      description: Search Postal Codes, Places or Countries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: postalcodes-info-search.searchpostalcodes
      with:
        q: tools.q
        country: tools.country
        region: tools.region
      outputParameters:
      - type: object
        mapping: $.