Skip to content
HALOWERK

Trade Operations

japan post town prefix search

Japanese locality autocomplete searches published town names inside one municipality. Use it when an agent needs to narrow an address entry without person lookup.

POST https://handel.halowerk.com/v1/japan-post-town-prefix-search

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
municipalitystringYes
querystringYes
limitintegerNo
Show full input schema
{
  "type": "object",
  "properties": {
    "municipality": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "query": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 25
    }
  },
  "required": [
    "municipality",
    "query"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "municipality": "13101",
  "query": "千",
  "limit": 1
}

Result & documentation

Show published result schema
{
  "$ref": "https://handel.halowerk.com/v1/japan-post-town-prefix-search/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 →