GuidesAPI Reference
Guides

Japan address system in HERE Geocoding and Search API v7

To reflect the Japanese administrative system and to support Japan use cases, we provide a response that includes block and subblock as additional hierarchical structures to support the country-specific scheme like chiban, aza, etc.

Discover

For more information, see Discover.

To discover the nearest station at the geo-position (35.7007524,139.8184107) use the following request:

GET https://discover.search.hereapi.com/v1/
    discover
    ?at=35.7007524,139.8184107
    &q=駅
    &limit=2
    &apiKey={YOUR_API_KEY}

The response to the above request is the following:

{
   items: [
      {
         title: "錦糸町駅",
         id: here:pds:place:392xn77j-bcc69b644f4aa59aba3e6568858ade4d,
         language: "ja",
         ontologyId: "here:cm:ontology:railway_station",
         resultType: "place",
         address: {
            label: "〒130-0022 東京都墨田区江東橋3丁目14-5 錦糸町駅",
            countryCode: "JPN",
            countryName: "日本",
            state: "東京都",
            city: "墨田区",
            subdistrict: "江東橋",
            block: "3丁目",
            subblock: "14",
            postalCode: "130-0022",
            houseNumber: "5"
         },
         position: {
            lat: 35.69674,
            lng: 139.81423
         },
         access: [
            {
               lat: 35.69595,
               lng: 139.81407
            }
         ],
         distance: 584,
         categories: [
            {
               id: "400-4100-0037",
               name: "地下鉄/メトロ",
               primary: true
            },
            {
               id: "400-4100-0035",
               name: "駅"
            },
            {
               id: "400-4100-0040",
               name: "公共交通機関出入口"
            }
         ]
      },
      {
         title: "錦糸町駅 (総武本線)",
         id: here:pds:place:392xn77j-38f30fbd915b631ddb5108474e4b688f,
         language: "ja",
         ontologyId: "here:cm:ontology:railway_station",
         resultType: "place",
         address: {
            label: "〒130-0022 東京都墨田区江東橋3丁目14-5 錦糸町駅 (総武本線)",
            countryCode: "JPN",
            countryName: "日本",
            state: "東京都",
            city: "墨田区",
            subdistrict: "江東橋",
            block: "3丁目",
            subblock: "14",
            postalCode: "130-0022",
            houseNumber: "5"
         },
         position: {
            lat: 35.69674,
            lng: 139.81423
         },
         access: [
            {
               lat: 35.69595,
               lng: 139.81407
            }
         ],
         distance: 584,
         categories: [
            {
               id: "400-4100-0035",
               name: "駅",
               primary: true
            }
         ]
      }
   ]
}

Geocode

For more information, see Geocode.

A free-form text query for address in Tokyo, 港区六本木6-10-1 is the following:

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?q=港区六本木6-10-1
    &apiKey={YOUR_API_KEY}

The response to the above request is the following:

{
   title: "〒106-0032 東京都港区六本木6丁目10-1",
   id: here:xs1:pointaddress:78553132:CgcIESCfjdoaEAEaATEiHuWFreacrOacqOODkuODq-OCuuajruOCv-ODr-ODvA,
   resultType: "houseNumber",
   houseNumberType: "PA",
   address: {
      label: "〒106-0032 東京都港区六本木6丁目10-1",
      countryCode: "JPN",
      countryName: "日本",
      state: "東京都",
      city: "港区",
      subdistrict: "六本木",
      block: "6丁目",
      subblock: "10",
      postalCode: "106-0032",
      houseNumber: "1"
   },
   position: {
      lat: 35.66045,
      lng: 139.72923
   },
   access: [
      {
         lat: 35.66053,
         lng: 139.72948
      }
   ],
   mapView: {
      west: 139.72812,
      south: 35.65955,
      east: 139.73034,
      north: 35.66135
   },
   scoring: {
      queryScore: 1,
      fieldScore: {
         city: 1,
         subdistrict: 1,
         block: 1,
         subblock: 1,
         houseNumber: 1
      }
   }
}

A free-form text query for address in Kumamoto Prefecture, 熊本県菊池郡大津町引水18-3 is the following:

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?q=熊本県菊池郡大津町引水18-3
    &apiKey={YOUR_API_KEY}

The response to the above request is the following:

{
   title: "〒869-1234 熊本県菊池郡大津町引水18-3",
   id: here:xs1:pointaddress:86810324:CgcIESDWv7IpEAEaATM,
   resultType: "houseNumber",
   houseNumberType: "PA",
   address: {
      label: "〒869-1234 熊本県菊池郡大津町引水18-3",
      countryCode: "JPN",
      countryName: "日本",
      state: "熊本県",
      county: "菊池郡",
      city: "大津町",
      subdistrict: "引水",
      subblock: "18",
      postalCode: "869-1234",
      houseNumber: "3"
   },
   position: {
      lat: 32.87821,
      lng: 130.87493
   },
   access: [
      {
         lat: 32.87822,
         lng: 130.87505
      }
   ],
   mapView: {
      west: 130.87386,
      south: 32.87731,
      east: 130.876,
      north: 32.87911
   },
   scoring: {
      queryScore: 1,
      fieldScore: {
         state: 1,
         county: 1,
         city: 1,
         subdistrict: 1,
         subblock: 1,
         houseNumber: 1
      }
   }
}

Autosuggest

For more information, see Autosuggest.

For 成田 suggestions intending to have 成田国際空港 somewhere in Tokyo, a query would be the following:

GET https://autosuggest.search.hereapi.com/v1/
    autosuggest
    ?at=35.6990575,139.7623009
    &q=成田
    &limit=2
    &apiKey={YOUR_API_KEY}

The response is the following:

{
   items: [
      {
         title: "成田国際空港",
         id: here:pds:place:392xn7g6-86c7b69e61ab0e2a3cbd76cc5e5bbb81,
         resultType: "place",
         address: {
            label: "〒286-0111 千葉県成田市三里塚-1 成田国際空港"
         },
         position: {
            lat: 35.77631,
            lng: 140.38636
         },
         access: [
            {
               lat: 35.77829,
               lng: 140.38053
            }
         ],
         distance: 56977,
         categories: [
            {
               id: "400-4000-4581",
               name: "空港",
               primary: true
            }
         ],
         highlights: {
            title: [
               {
                  start: 0,
                  end: 2
               }
            ],
            address: {
               label: [
                  {
                     start: 22,
                     end: 24
                  }
               ]
            }
         }
      },
      {
         title: "千葉県成田市",
         id: here:xs1:namedplace:32452900,
         resultType: "locality",
         localityType: "city",
         address: {
            label: "千葉県成田市"
         },
         position: {
            lat: 35.77674,
            lng: 140.31896
         },
         distance: 50979,
         mapView: {
            west: 140.24982,
            south: 35.72308,
            east: 140.47257,
            north: 35.9026
         },
         highlights: {
            title: [
               {
                  start: 3,
                  end: 5
               }
            ],
            address: {
               label: [
                  {
                     start: 3,
                     end: 5
                  }
               ]
            }
         }
      }
   ],
   "queryTerms": []
}

Browse

For more information, see Browse.

For example, a customer application wants to expose an icon representing a convenience store and use the category id 600-6000-0061 as the value for the categories parameter in a /browse endpoint query:

GET https://browse.search.hereapi.com/v1/
    browse
    ?at=35.7064554,139.7398739
    &categories=600-6000-0061
    &limit=2
    &apiKey={YOUR_API_KEY}
{
   items: [
      {
         title: "ファミリーマート東五軒町店",
         id: here:pds:place:392xn775-e84ed0cfbbae634066db2ccccc406d99,
         language: "ja",
         resultType: "place",
         address: {
            label: "〒162-0813 東京都新宿区東五軒町5-19 ファミリーマート東五軒町店",
            countryCode: "JPN",
            countryName: "日本",
            state: "東京都",
            city: "新宿区",
            subdistrict: "東五軒町",
            subblock: "5",
            postalCode: "162-0813",
            houseNumber: "19"
         },
         position: {
            lat: 35.70698,
            lng: 139.73984
         },
         access: [
            {
               lat: 35.70714,
               lng: 139.73987
            }
         ],
         distance: 58,
         categories: [
            {
               id: "600-6000-0061",
               name: "コンビニエンスストア",
               primary: true
            }
         ],
         chains: [
            {
               id: "6314",
               name: "ファミリーマート"
            }
         ],
         contacts: [
            {
               phone: [
                  {
                     value: "+81352063351"
                  }
               ]
            }
         ],
         openingHours: [
            {
               text: [
                  "月-日: 00:00 - 24:00"
               ],
               isOpen: true,
               structured: [
                  {
                     start: "T000000",
                     duration: "PT24H00M",
                     recurrence: "FREQ:DAILY;BYDAY:MO,TU,WE,TH,FR,SA,SU"
                  }
               ]
            }
         ]
      },
      {
         title: "ローソン新宿新小川町店",
         id: here:pds:place:392xn775-229482719146a338961f502216a0627a,
         language: "ja",
         resultType: "place",
         address: {
            label: "〒162-0814 東京都新宿区新小川町8-9 ローソン新宿新小川町店",
            countryCode: "JPN",
            countryName: "日本",
            state: "東京都",
            city: "新宿区",
            subdistrict: "新小川町",
            subblock: "8",
            postalCode: "162-0814",
            houseNumber: "9"
         },
         position: {
            lat: 35.7061,
            lng: 139.74071
         },
         access: [
            {
               lat: 35.70606,
               lng: 139.74055
            }
         ],
         distance: 86,
         categories: [
            {
               id: "600-6000-0061",
               name: "コンビニエンスストア",
               primary: true
            }
         ],
         chains: [
            {
               id: "6309",
               name: "ローソン"
            }
         ],
         contacts: [
            {
               phone: [
                  {
                     value: "+81332673963"
                  }
               ]
            }
         ],
         openingHours: [
            {
               text: [
                  "月-日: 00:00 - 24:00"
               ],
               isOpen: true,
               structured: [
                  {
                     start: "T000000",
                     duration: "PT24H00M",
                     recurrence: "FREQ:DAILY;BYDAY:MO,TU,WE,TH,FR,SA,SU"
                  }
               ]
            }
         ]
      }
   ]
}

Lookup by ID

For more information, see Lookup.

The HERE ID for 札幌駅(Sapporo Station) is here:pds:place:392xpst0-292aef9721e6b3c3335c5e8e299a9624. To retrieve details for the place, send the following request:

GET https://lookup.search.hereapi.com/v1/
    lookup
    ?id=here:pds:place:392xpst0-292aef9721e6b3c3335c5e8e299a9624
    &apiKey={YOUR_API_KEY}

The response to the above query is the following:

{
   title: "札幌駅",
   id: here:pds:place:392xpst0-292aef9721e6b3c3335c5e8e299a9624,
   language: "ja",
   resultType: "place",
   address: {
      label: "〒060-0806 北海道札幌市北区北6条西3丁目 札幌駅",
      countryCode: "JPN",
      countryName: "日本",
      state: "北海道",
      city: "札幌市",
      district: "北区",
      subdistrict: "北6条西",
      block: "3丁目",
      postalCode: "060-0806"
   },
   position: {
      lat: 43.06859,
      lng: 141.35075
   },
   access: [
      {
         lat: 43.06911,
         lng: 141.34989
      }
   ],
   categories: [
      {
         id: "400-4100-0035",
         name: "駅",
         primary: true
      },
      {
         id: "400-4100-0040",
         name: "公共交通機関出入口"
      }
   ]
}

Reverse Geocode

For more information, see Reverse Geocode.

For example, a user selects a point on the map in Yokohama and submits the map geo-coordinates in a request to the revgeocode endpoint as in the following:

GET https://lookup.search.hereapi.com/v1/
    lookup
    ?id=here:pds:place:392xpst0-292aef9721e6b3c3335c5e8e299a9624
    &apiKey={YOUR_API_KEY}

The response for this example shows the nearest address available:

{
   title: "札幌駅",
   id: here:pds:place:392xpst0-292aef9721e6b3c3335c5e8e299a9624,
   language: "ja",
   resultType: "place",
   address: {
      label: "〒060-0806 北海道札幌市北区北6条西3丁目 札幌駅",
      countryCode: "JPN",
      countryName: "日本",
      state: "北海道",
      city: "札幌市",
      district: "北区",
      subdistrict: "北6条西",
      block: "3丁目",
      postalCode: "060-0806"
   },
   position: {
      lat: 43.06859,
      lng: 141.35075
   },
   access: [
      {
         lat: 43.06911,
         lng: 141.34989
      }
   ],
   categories: [
      {
         id: "400-4100-0035",
         name: "駅",
         primary: true
      },
      {
         id: "400-4100-0040",
         name: "公共交通機関出入口"
      }
   ]
}