Interface NTAEntityAddress

An NTAEntityAddress object would store the domestic or foreign address.

interface NTAEntityAddress {
    block_lot_num: null | string;
    building: null | string;
    city: null | string;
    city_kana: null | string;
    city_roman: null | string;
    floor_room: null | string;
    jisx0402: null | string;
    kyoto_street: null | string;
    postal_code: null | string;
    prefecture: null | string;
    prefecture_kana: null | string;
    prefecture_roman: null | string;
    street_number: string;
    town: null | string;
}

Properties

block_lot_num building city city_kana city_roman floor_room jisx0402 kyoto_street postal_code prefecture prefecture_kana prefecture_roman street_number town

Properties

block_lot_num

block_lot_num: null | string

The reconstructed numerical part of the address line below the second-level administrative division.

Example: "3-12-14"

building

building: null | string

The extracted building name in the address line below the second-level administrative division, without the floor name.

Example: "麹町駅前ヒルトップ"

city

city: null | 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

city_kana: null | string

The reading of the name of the city in katakana. 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_roman

city_roman: null | string

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

Examples:

  • "Minato-ku"
  • "Kita-ku, Osaka"
  • "Kakamigahara"
  • "Nagatoro"

floor_room

floor_room: null | string

The extracted floor name and room number in the address line below the second-level administrative division.

Example: "8階801"

jisx0402

jisx0402: null | string

The 5 digit Japanese municipality code (全国地方公共団体コード) for the administrative division where the place this object represents belongs. Can be null either for the foreign address, or the address is based on the old address system.

kyoto_street

kyoto_street: null | string

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

Example: "先斗町通蛸薬師上る"

postal_code

postal_code: null | string

The postal code for the place this object represents.

prefecture

prefecture: null | string

The name of the prefecture in Kanji.

Example: "東京都"

prefecture_kana

prefecture_kana: null | string

The reading of the name of the prefecture in katakana.

Example: "トウキョウト"

prefecture_roman

prefecture_roman: null | string

The "romanized" reading of the name of the prefecture.

Example: "Tokyo"

street_number

street_number: string

The part of the address line below the second-level administrative division. The string is preprocessed so it would fit within 300 characters by NTA if it is longer than that length actually. If the text uses a Kanji which is not JIS Level 1 or 2, The Kanji will be converted into correspondent JIS Level 1 or 2 Kanjis. You can refer to the unnormalized version of the text from a correspondent image file. See address_image_id for details.

Example: "麹町３丁目１２－１４麹町駅前ヒルトップ８階"

town

town: null | string

The extracted name of the third-level administrative division, which correspond to the "o-aza", or the "cho" with its chome part stripped out.

Example: "麹町"

Settings

Member Visibility

On This Page

Properties