Geocoder API Developer's Guide

Area around a Location

The user wants to retrieve the district surrounding a location in Berlin (52.5309°N 13.3847°E).

Request

The following GET request uses the parameter prox to specify the location of the address are provided and the parameter mode to define the action taken.

https://reverse.geocoder.ls.hereapi.com/6.2/reversegeocode.json
?apiKey={YOUR_API_KEY}
&mode=retrieveAreas
&prox=52.5309,13.3847,250
Note: This example uses a HERE API Key to authenticate your request. For information on other possible options, see Authentication Guide. For examples of how to use the other authentication options with the Geocoder API, see Authentication Examples.

Response

The response to the request contains the following information blocks:
  • metadata about the information used in determining the route
  • information about the area, including
    • match quality
    • location information
    • address information
    • map reference information
{"Response": {
  "MetaInfo": {"Timestamp": "2016-11-08T08:51:06.020+0000"},
  "View": [{
    "_type": "SearchResultsViewType",
    "ViewId": 0,
    "Result": [{
      "Relevance": 1,
      "Distance": 0,
      "Direction": 0,
      "MatchLevel": "district",
      "MatchQuality": {
        "Country": 1,
        "State": 1,
        "County": 1,
        "City": 1,
        "District": 1,
        "PostalCode": 1
      },
      "Location": {
        "LocationId": "NT_0ES-GaH3lZzJCuLQBrdw7C",
        "LocationType": "point",
        "DisplayPosition": {
          "Latitude": 52.5309,
          "Longitude": 13.3847
        },
        "MapView": {
          "TopLeft": {
            "Latitude": 52.54063,
            "Longitude": 13.36566
          },
          "BottomRight": {
            "Latitude": 52.50407,
            "Longitude": 13.42965
          }
        },
        "Address": {
          "Label": "Mitte, Berlin, Deutschland",
          "Country": "DEU",
          "State": "Berlin",
          "County": "Berlin",
          "City": "Berlin",
          "District": "Mitte",
          "PostalCode": "10178",
          "AdditionalData": [
            {
              "value": "Deutschland",
              "key": "CountryName"
            },
            {
              "value": "Berlin",
              "key": "StateName"
            },
            {
              "value": "Berlin",
              "key": "CountyName"
            }
          ]
        },
        "MapReference": {
          "ReferenceId": "53500282",
          "SideOfStreet": "neither",
          "CountryId": "20147700",
          "StateId": "20187401",
          "CountyId": "20187402",
          "CityId": "20187403",
          "DistrictId": "20187417"
        }
      }
    }]
  }]
}}