教えて郵便番号 2

教えて郵便番号 2 · GPT アクション

Get postal code data

Retrieves postal code data for a given address.

  • GET /postcodes.jsonGetPostalCodeByAddress

    Get postal codes for a specific address

元の API スキーマ
{
  "openapi": "3.1.0",
  "info": {
    "title": "Get postal code data",
    "description": "Retrieves postal code data for a given address.",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://postcode.teraren.com"
    }
  ],
  "paths": {
    "/postcodes.json": {
      "get": {
        "description": "Get postal codes for a specific address",
        "operationId": "GetPostalCodeByAddress",
        "parameters": [
          {
            "name": "s",
            "in": "query",
            "description": "The address or part of the address to retrieve the postal codes for",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "PostalCodeResponse": {
        "type": "object",
        "properties": {
          "jis": {
            "type": "string"
          },
          "new": {
            "type": "string"
          },
          "prefecture_kana": {
            "type": "string"
          },
          "city_kana": {
            "type": "string"
          },
          "suburb_kana": {
            "type": "string"
          },
          "prefecture": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "suburb": {
            "type": "string"
          },
          "street_address": {
            "type": "string"
          },
          "is_separated_suburb": {
            "type": "integer"
          },
          "is_koaza": {
            "type": "integer"
          },
          "is_chome": {
            "type": "integer"
          },
          "is_include_area": {
            "type": "integer"
          },
          "postcode_type": {
            "type": "integer"
          },
          "office": {
            "type": "string"
          },
          "office_kana": {
            "type": "string"
          },
          "post_type": {
            "type": "string"
          },
          "multiple_numbers": {
            "type": "string"
          }
        }
      }
    }
  }
}