Skip to content
HALOWERK

Trade Operations

japan post address components

Japanese address parsing returns prefecture, municipality, locality and recognized chome, block and house numbers. Use it when an agent needs structured shipping address components.

POST https://handel.halowerk.com/v1/japan-post-address-components

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
addressstringYes
response_languageSee schemaNo
parser_profileSee schemaNo
postal_codestring, nullNo
Show full input schema
{
  "type": "object",
  "properties": {
    "address": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "response_language": {
      "enum": [
        "ja",
        "both"
      ]
    },
    "parser_profile": {
      "enum": [
        "standard",
        "strict"
      ]
    },
    "postal_code": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20
    }
  },
  "required": [
    "address"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "address": "東京都千代田区千代田1丁目1番1号"
}

Result & documentation

Show published result schema
{
  "$ref": "https://handel.halowerk.com/v1/japan-post-address-components/schema#/outputSchema"
}

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-20 UTC.

More endpoints in this hub

All endpoints in this hub →