A Address object would store the information about the resolved area, place, or organization.

interface Address {
    building: string;
    city: string;
    city_kana: string;
    corporation: null | v20220901.Corporation;
    floor: string;
    jisx0402: string;
    koaza: string;
    kyoto_street: null | string;
    old_code: string;
    postal_code: string;
    prefecture: string;
    prefecture_kana: string;
    town: string;
    town_addressed_koaza: boolean;
    town_chome: boolean;
    town_kana: string;
    town_kana_raw: string;
    town_multi: boolean;
    town_partial: boolean;
    town_raw: string;
}

Properties

building: string

The name of the building, in case the postal code is designated to a building, or its each floor.

This is a synthetic value; that means it resulted from our original interpretation of the town_raw data, and the corresponding value might well not be present in the original KEN_ALL data provided by Japan Post.

Examples:

  • "オフィスタワーX"
city: string

The name of the city. The county name may precede it, or the name of the ward would follow it in case the city has ordinance-designated wards.

Examples:

  • "港区"
  • "大阪市北区"
  • "各務原市"
  • "秩父郡長瀞町"
city_kana: string

The reading of the name of the city in katakana.

Examples:

  • "ミナトク"
  • "オオサカシキタク"
  • "カカミガハラシ"
  • "チチブグンナガトロマチ"
corporation: null | v20220901.Corporation

If the postal code is designated to an organization, or a division of such, this property stores the Corporation object that describes it.

floor: string

The floor of the building.

This is a synthetic value; that means it resulted from our original interpretation of the town_raw data, and the corresponding value might well not be present in the original KEN_ALL data provided by Japan Post.

Examples:

  • "1階"
jisx0402: string

The 5 digit Japanese municipality code (全国地方公共団体コード) for the administrative division where the place this object represents belongs.

koaza: string

The name of the (non-administrative) sub-area of the town.

This is a synthetic value; that means it resulted from our original interpretation of the town_raw data, and the corresponding value might well not be present in the original KEN_ALL data provided by Japan Post.

Examples:

  • "第2地割"
  • "1丁目"
kyoto_street: null | string

The instructional phrase (通り名 in Japanese) very specific to Kyoto city, which helps one to locate the place out of the area of the town.

This is a synthetic value; that means it resulted from our original interpretation of the town_raw data, and the corresponding value might well not be present in the original KEN_ALL data provided by Japan Post.

Examples:

  • "先斗町通蛸薬師上る"
  • "大宮通寺之内半丁下る東入"
old_code: string

The "old" postal code that was used before February 2, 1998.

postal_code: string

The postal code for the place this object represents.

prefecture: string

The name of the prefecture in Kanji.

Example: "東京都"

prefecture_kana: string

The reading of the name of the prefecture in katakana.

Example: "トウキョウト"

town: string

The name of the area that usually corresponds to lowest part of the administrative division levels ("town").

This is a synthetic value; that means it resulted from our original interpretation of the town_raw data, and the corresponding value might well not be present in the original KEN_ALL data provided by Japan Post.

Examples:

  • "箱石"
  • "晴海"
  • "西北小路町"
town_addressed_koaza: boolean

For the detail of the meaning of this property, See the API documentation. The value has no use; we recommend not referring to this.

town_chome: boolean

For the detail of the meaning of this property, See the API documentation. The value has no use; we recommend not referring to this.

town_kana: string

The reading of the name of the town.

This is a synthetic value; that means it resulted from our original interpretation of the town_raw data, and the corresponding value might well not be present in the original KEN_ALL data provided by Japan Post.

Examples:

  • "ハコイシ"
  • "ハルミ"
  • "ニシキタコウジチョウ"
town_kana_raw: string

The reading of the unprocessed value(s) of the name of the area.

Examples:

  • "イワテケンミヤコシハコイシ(ダイ2チワリ<70-136>-ダイ4チワリ<3-11>)"
  • "ニシキタコウジチョウ"
  • "トウキョウトチユウオウクハルミ オフイスタワーX 1カイ"
town_multi: boolean

For the detail of the meaning of this property, See the API documentation. The value has no use; we recommend not referring to this.

town_partial: boolean

For the detail of the meaning of this property, See the API documentation. The value has no use; we recommend not referring to this.

town_raw: string

The unprocessed value(s) of the name of the area. It may consist of multiple (non-administrative) sub-areas.

Note that they don't always represent the actual name of the area, in case they are expediently designated by Japan Post.

Examples:

  • "岩手県宮古市箱石(第2地割「70〜136」〜第4地割「3〜11」)"
  • "西北小路町(猪熊通上立売上る、猪熊通寺之内下る、大宮通寺之内下る東入、大宮通寺之内半丁下る東入、大宮通寺之内下る東入1丁目、寺之内通大宮東入下る、寺之内通大宮東入1丁目下る)"
  • "晴海 オフィスタワーX 1階"