住所探しのお手伝いさん.

住所探しのお手伝いさん. · Acciones GPT

Japanese Postal Code Lookup API

Provides address information based on Japanese postal codes

  • GET /api/searchGetAddressByPostalCode

    Retrieves address information based on a postal code

Esquema original API
{
  "openapi": "3.1.0",
  "info": {
    "title": "Japanese Postal Code Lookup API",
    "description": "Provides address information based on Japanese postal codes",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://zipcloud.ibsnet.co.jp"
    }
  ],
  "paths": {
    "/api/search": {
      "get": {
        "description": "Retrieves address information based on a postal code",
        "operationId": "GetAddressByPostalCode",
        "parameters": [
          {
            "name": "zipcode",
            "in": "query",
            "required": true,
            "description": "The postal code to lookup",
            "schema": {
              "type": "string",
              "pattern": "^[0-9]{3}-?[0-9]{4}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddressResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AddressResponse": {
        "type": "object",
        "properties": {
          "address1": {
            "type": "string",
            "description": "The first part of the address"
          },
          "address2": {
            "type": "string",
            "description": "The second part of the address"
          },
          "address3": {
            "type": "string",
            "description": "The third part of the address"
          },
          "kana1": {
            "type": "string",
            "description": "The first part of the address in Kana"
          },
          "kana2": {
            "type": "string",
            "description": "The second part of the address in Kana"
          },
          "kana3": {
            "type": "string",
            "description": "The third part of the address in Kana"
          },
          "prefcode": {
            "type": "string",
            "description": "Prefecture code"
          },
          "zipcode": {
            "type": "string",
            "description": "Postal code"
          }
        },
        "required": [
          "address1",
          "address2",
          "address3",
          "zipcode"
        ]
      }
    }
  }
}