Skip to main content

UPUJP

Example Record

FieldExampleType

Every field is documented below.

Core Address Fields

id string
ID
Example upujp_2ry6tOmv4gOAWU2v5CVxBw|12-2
dataset string
Dataset

Indicates the provenance of an address

Example upujp
Enum
  • "upujp"
country string
Country

Full country names (ISO 3166)

Example Japan
Enum
  • "Japan"
country_iso string
Country ISO

3 letter country code (ISO 3166-1)

Example JPN
Enum
  • "JPN"
country_iso_2 string
Country ISO 2

2 letter country code (ISO 3166-1)

Example JP
Enum
  • "JP"
language string
Language

Language represented by 2 letter ISO Code (639-1)

Example ja
Enum
  • "ja"
  • "en"
script string
Script

ISO 15924 script of the address elements.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Example Hani
Enum
  • "Hani"
  • "Hira"
  • "Latn"
address string
Address

Address / House Number uniquely identifying the address along the specified street.

Can be empty string "" if not present.

Example 12-2
line_1 string
Address Line 1

The block or house number alone, identical to address. There is no line_2 or line_3; build the rest of the address from prefecture, city, district, neighbourhood and building_name.

Can be empty string "" if not present.

Example 12-2
building_name string
Building Name

Preferred building name.

Can be empty string "" if not present.

Example Empty in this example
neighbourhood string
Neighbourhood

Preferred neighbourhood name.

Can be empty string "" if not present.

Example 神楽六条十三丁目
district string
District

Preferred district name.

Can be empty string "" if not present.

Example Empty in this example
city string
City

Preferred city name.

Can be empty string "" if not present.

Example 旭川市
prefecture string
Prefecture

Preferred prefecture name.

Can be empty string "" if not present.

Example 北海道
postcode string
Postcode

Preferred postal code.

Can be empty string "" if not present.

Example 070-8006
latitude string
Latitude
Example Empty in this example
longitude string
Longitude
Example Empty in this example

Organisation Information

org_id string
Org ID

The unique identifier of an organisation.

Can be empty string "" if not present.

Example Empty in this example
org_type_ind string | number
Org Type Ind

Indicates the type of organisation.

Can be empty string "" if not present.

Example Empty in this example
org_sub_type_ind string | number
Org Sub Type Ind

Indicates the sub-type of the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_loc_id string
Org Loc ID

Locality identifier for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_dis_id string
Org Dis ID

District identifier for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_nei_id string
Org Nei ID

Neighbourhood identifier for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_org_id string
Org Org ID

Associated organisation identifier for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_name string
Org Name

Name of the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_name_trans string
Org Name Trans

Translated name of the organisation in Latin script.

Can be empty string "" if not present.

Example Empty in this example
org_loc_sfx string
Org Loc Sfx

Suffix of the locality for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_loc_sfx_trans string
Org Loc Sfx Trans

Translated suffix of the locality for the organisation in Latin script.

Can be empty string "" if not present.

Example Empty in this example
org_adr string
Org Adr

Address of the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_adr_trans string
Org Adr Trans

Translated address of the organisation in Latin script.

Can be empty string "" if not present.

Example Empty in this example
org_po_ind string | number
Org PO Ind

Indicates whether the organisation has a post office box.

Can be empty string "" if not present.

Example Empty in this example
org_po_start string
Org PO Start

Post office box number or start of the post office box range associated with the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_po_end string
Org PO End

End of the post office box range associated with the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_dsc string
Org Dsc

Additional information about the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_dsc_trans string
Org Dsc Trans

Translated additional information about the organisation in Latin script.

Can be empty string "" if not present.

Example Empty in this example
org_pcode string
Org Pcode

Postal code for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_pcode_fin string
Org Pcode Fin

Final postal code for the organisation.

Can be empty string "" if not present.

Example Empty in this example
org_script string
Org Script

Script used for the organisation name.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

Example Empty in this example
org_language string
Org Language

Language used for the organisation name.

Can be empty string "" if not present.

Example Empty in this example

Street Information

str_id string
Str ID

Identifier of the street (not unique).

Can be empty string "" if not present.

Example 0
str_key string
Str Key

Permanent identifier of the street.

Can be empty string "" if not present.

Example Empty in this example
str_loc_id string
Str Loc ID

Locality identifier for the street.

Can be empty string "" if not present.

Example 914161
str_dis_id string
Str Dis ID

District identifier for the street.

Can be empty string "" if not present.

Example Empty in this example
str_nei_id string
Str Nei ID

Neighbourhood identifier for the street.

Can be empty string "" if not present.

Example 194855
str_org_id string
Str Org ID

Associated organisation identifier for the street.

Can be empty string "" if not present.

Example Empty in this example
str_pfx string
Str Pfx

Prefix of the street name.

Can be empty string "" if not present.

Example Empty in this example
str_pfx_trans string
Str Pfx Trans

Translated prefix of the street name in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_qlf_pre string
Str Qlf Pre

Preceding qualifier of the street name.

Can be empty string "" if not present.

Example Empty in this example
str_qlf_pre_trans string
Str Qlf Pre Trans

Translated preceding qualifier of the street name in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_qlf_suc string
Str Qlf Suc

Succeeding qualifier of the street name.

Can be empty string "" if not present.

Example Empty in this example
str_qlf_suc_trans string
Str Qlf Suc Trans

Translated succeeding qualifier of the street name in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_name string
Str Name

Name of the street.

Can be empty string "" if not present.

Example Empty in this example
str_name_trans string
Str Name Trans

Translated name of the street in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_loc_sfx string
Str Loc Sfx

Suffix of the locality for the street.

Can be empty string "" if not present.

Example Empty in this example
str_loc_sfx_trans string
Str Loc Sfx Trans

Translated suffix of the locality for the street in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_type string
Str Type

Type of the street.

Can be empty string "" if not present.

Example Empty in this example
str_type_trans string
Str Type Trans

Translated type of the street in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_type_abv string
Str Type Abv

Abbreviation of the street type.

Can be empty string "" if not present.

Example Empty in this example
str_type_abv_trans string
Str Type Abv Trans

Translated abbreviation of the street type in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_adr_num_key string
Str Adr Num Key

Permanent identifier of the address.

Can be empty string "" if not present.

Example Empty in this example
str_from_num string | number
Str From Num

Lowest address number on the street.

Can be empty string "" if not present.

Example 2
str_from_unit string
Str From Unit

Lowest unit number on the street.

Can be empty string "" if not present.

Example 12
str_from_alph string
Str From Alph

Extension of the lowest address number on the street.

Can be empty string "" if not present.

Example Empty in this example
str_to_num string | number
Str To Num

Highest address number on the street.

Can be empty string "" if not present.

Example 2
str_to_unit string
Str To Unit

Highest unit number on the street.

Can be empty string "" if not present.

Example 12
str_to_alph string
Str To Alph

Extension of the highest address number on the street.

Can be empty string "" if not present.

Example Empty in this example
str_evenodd string | number
Str Evenodd

Indicates whether the address range for this street contains even numbers, odd numbers, or both.

Can be empty string "" if not present.

Example 6
str_dsc string
Str Dsc

Additional information about the street.

Can be empty string "" if not present.

Example Empty in this example
str_dsc_trans string
Str Dsc Trans

Translated additional information about the street in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_blg_id string
Str Blg ID

Identifier of the building for the street.

Can be empty string "" if not present.

Example 49928324
str_blg_name string
Str Blg Name

Name of the building for the street.

Can be empty string "" if not present.

Example Empty in this example
str_blg_name_trans string
Str Blg Name Trans

Translated name of the building for the street in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_blg_type string
Str Blg Type

Type of the building for the street.

Can be empty string "" if not present.

Example
str_blg_type_trans string
Str Blg Type Trans

Translated type of the building for the street in Latin script.

Can be empty string "" if not present.

Example BAN
str_blg_dsc string
Str Blg Dsc

Additional information about the building for the street.

Can be empty string "" if not present.

Example Empty in this example
str_blg_dsc_trans string
Str Blg Dsc Trans

Translated additional information about the building for the street in Latin script.

Can be empty string "" if not present.

Example Empty in this example
str_ref_str_id string
Str Ref Str ID

Identifier of the associated street.

Can be empty string "" if not present.

Example Empty in this example
str_pcode string
Str Pcode

Postal code for the street.

Can be empty string "" if not present.

Example 070-8006
str_script string
Str Script

Script used for the street name.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

Example Empty in this example
str_language string
Str Language

Language used for the street name.

Can be empty string "" if not present.

Example Empty in this example

Sub-District & Sub-Neighbourhood Information

sub_dis_id string
Sub Dis ID

Unique identifier of the district.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_key string
Sub Dis Key

Permanent identifier of the district.

Can be empty string "" if not present.

Example Empty in this example
sub_loc_id string
Sub Loc ID

Locality identifier for the subdivision.

Can be empty string "" if not present.

Example 914161
sub_loc_sfx string
Sub Loc Sfx

Suffix of the locality for the subdivision.

Can be empty string "" if not present.

Example Empty in this example
sub_loc_sfx_trans string
Sub Loc Sfx Trans

Translated suffix of the locality for the subdivision in Latin script.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_name string
Sub Dis Name

Name of the district.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_name_trans string
Sub Dis Name Trans

Translated name of the district in Latin script.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_sfx string
Sub Dis Sfx

Suffix of the district.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_sfx_trans string
Sub Dis Sfx Trans

Translated suffix of the district in Latin script.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_dsc string
Sub Dis Dsc

Additional information about the district.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_dsc_trans string
Sub Dis Dsc Trans

Translated additional information about the district in Latin script.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_pcode string
Sub Dis Pcode

Postal code for the district.

Can be empty string "" if not present.

Example Empty in this example
sub_dis_pcode_fin string
Sub Dis Pcode Fin

Final postal code for the district.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_id string
Sub Nei ID

Identifier of the neighbourhood.

Can be empty string "" if not present.

Example 194855
sub_nei_key string
Sub Nei Key

Permanent identifier of the neighbourhood.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_name string
Sub Nei Name

Name of the neighbourhood.

Can be empty string "" if not present.

Example 神楽六条十三丁目
sub_nei_name_trans string
Sub Nei Name Trans

Translated name of the neighbourhood in Latin script.

Can be empty string "" if not present.

Example KAGURA 6JO 13-CHOME
sub_nei_sfx string
Sub Nei Sfx

Suffix of the neighbourhood.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_sfx_trans string
Sub Nei Sfx Trans

Translated suffix of the neighbourhood in Latin script.

Can be empty string "" if not present.

Example G
sub_nei_zone_from string
Sub Nei Zone From

Start of the range of zone numbers to which the neighbourhood postal code corresponds.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_zone_to string
Sub Nei Zone To

End of the range of zone numbers to which the neighbourhood postal code corresponds.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_dsc string
Sub Nei Dsc

Additional information about the neighbourhood.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_dsc_trans string
Sub Nei Dsc Trans

Translated additional information about the neighbourhood in Latin script.

Can be empty string "" if not present.

Example Empty in this example
sub_nei_pcode string
Sub Nei Pcode

Postal code for the neighbourhood.

Can be empty string "" if not present.

Example 070-8006
sub_script string
Sub Script

Script used for the subdivision names.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

Example Hani
sub_language string
Sub Language

Language used for the subdivision names.

Can be empty string "" if not present.

Example ja

Location Hierarchy

loc_id string
Loc ID

Unique identifier of the locality.

Can be empty string "" if not present.

Example 914161
loc_key string
Loc Key

Permanent identifier of the locality.

Can be empty string "" if not present.

Example 3265925806
loc_adm1_id string
Loc Adm1 ID

Identifier of administrative division 1.

Can be empty string "" if not present.

Example 12010
loc_adm1_key string
Loc Adm1 Key

Permanent identifier of administrative division 1.

Can be empty string "" if not present.

Example JP.HK
loc_adm1_name string
Loc Adm1 Name

Name of administrative division 1.

Can be empty string "" if not present.

Example 北海道
loc_adm1_name_trans string
Loc Adm1 Name Trans

Translated name of administrative division 1 in Latin script.

Can be empty string "" if not present.

Example HOKKAIDO
loc_adm1_sfx string
Loc Adm1 Sfx

Suffix of administrative division 1.

Can be empty string "" if not present.

Example Empty in this example
loc_adm1_sfx_trans string
Loc Adm1 Sfx Trans

Translated suffix of administrative division 1 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm1_abv string
Loc Adm1 Abv

Abbreviation of administrative division 1.

Can be empty string "" if not present.

Example Empty in this example
loc_adm1_abv_trans string
Loc Adm1 Abv Trans

Translated abbreviation of administrative division 1 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_id string
Loc Adm2 ID

Identifier of administrative division 2.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_key string
Loc Adm2 Key

Permanent identifier of administrative division 2.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_name string
Loc Adm2 Name

Name of administrative division 2.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_name_trans string
Loc Adm2 Name Trans

Translated name of administrative division 2 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_sfx string
Loc Adm2 Sfx

Suffix of administrative division 2.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_sfx_trans string
Loc Adm2 Sfx Trans

Translated suffix of administrative division 2 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_abv string
Loc Adm2 Abv

Abbreviation of administrative division 2.

Can be empty string "" if not present.

Example Empty in this example
loc_adm2_abv_trans string
Loc Adm2 Abv Trans

Translated abbreviation of administrative division 2 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_id string
Loc Adm3 ID

Identifier of administrative division 3.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_key string
Loc Adm3 Key

Permanent identifier of administrative division 3.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_name string
Loc Adm3 Name

Name of administrative division 3.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_name_trans string
Loc Adm3 Name Trans

Translated name of administrative division 3 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_sfx string
Loc Adm3 Sfx

Suffix of administrative division 3.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_sfx_trans string
Loc Adm3 Sfx Trans

Translated suffix of administrative division 3 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_abv string
Loc Adm3 Abv

Abbreviation of administrative division 3.

Can be empty string "" if not present.

Example Empty in this example
loc_adm3_abv_trans string
Loc Adm3 Abv Trans

Translated abbreviation of administrative division 3 in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_name string
Loc Name

Name of the locality.

Can be empty string "" if not present.

Example 旭川市
loc_name_trans string
Loc Name Trans

Translated name of the locality in Latin script.

Can be empty string "" if not present.

Example ASAHIKAWA
loc_sfx string
Loc Sfx

Suffix of the locality.

Can be empty string "" if not present.

Example Empty in this example
loc_sfx_trans string
Loc Sfx Trans

Translated suffix of the locality in Latin script.

Can be empty string "" if not present.

Example -SHI
loc_pcode string
Loc Pcode

Postal code of the locality.

Can be empty string "" if not present.

Example 070-0000
loc_pcode_fin string
Loc Pcode Fin

Final postal code of the locality.

Can be empty string "" if not present.

Example Empty in this example
loc_dsc string
Loc Dsc

Additional information about the locality.

Can be empty string "" if not present.

Example Empty in this example
loc_dsc_trans string
Loc Dsc Trans

Translated additional information about the locality in Latin script.

Can be empty string "" if not present.

Example Empty in this example
loc_script string
Loc Script

Script used for the locality names.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

Example Hani
loc_language string
Loc Language

Language used for the locality names.

Can be empty string "" if not present.

Example ja