Reverse geocode

Learn how to find an address near a location with the Geocoding service.

Reverse geocoding is the process of converting a location to an address or place. To reverse geocode, use the Geocoding service and the reverseGeocode operation. This operation requires an initial location and returns an address with attributes such as place name and location. To simplify accessing the Geocoding service, you use the locator module.

In this tutorial, you will use the locator to reverse geocode and find the closest address to your clicked location on the map.

Prerequisites

Steps

Create a new pen

To get started, either complete the Display a map tutorial or .

Get an access token

You need an access token with the correct privileges to access the location services used in this tutorial.

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps
  - Location services > Geocoding

In CodePen, set esriConfig.apiKey to your access token.

Use dark colors for code blocks
  var esriConfig = {
    apiKey: "YOUR_ACCESS_TOKEN"
  };

To learn about other ways to get an access token, go to Types of authentication.

Update the map

A streets basemap layer is typically used in geocoding applications. Update the basemap attribute to use the arcgis/navigation basemap layer and change the position of the map to center on Quito.

Update the basemap attribute from arcgis/topographic to arcgis/navigation. Then, update the center attribute to -78.50169,-0.21489, and set the zoom attribute to 12.

Expand
Use dark colors for code blocks
    <arcgis-map basemap="arcgis/navigation" center="-78.50169, -0.21489" zoom="12">

      <arcgis-zoom position="top-left"></arcgis-zoom>

    </arcgis-map>
Expand

Add modules and event listener

Add a <script> tag in the <body> following the <arcgis-map> component with a require statement. In the require statement, add the locator module.

The ArcGIS Maps SDK for JavaScript is available as AMD modules and ES modules, but this tutorial is based on AMD. The AMD require function uses references to determine which modules will be loaded – for example, you can specify "esri/layers/FeatureLayer" for loading the FeatureLayer module. After the modules are loaded, they are passed as parameters (e.g. FeatureLayer) to the callback function where they can be used in your application. It is important to keep the module references and callback parameters in the same order. To learn more about the API's different modules visit the Overview Guide page.

Within the require statement, use the document.querySelector() method to access the map component.
Expand
Use dark colors for code blocks
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
    <script>

      require(["esri/rest/locator"], (locator) => {

        const arcgisMap = document.querySelector("arcgis-map");

      });

    </script>
```
Expand

Create an event listener to listen for the map component's arcgisViewReadyChange event.

Expand
Use dark colors for code blocks
    <script>

      require(["esri/rest/locator"], (locator) => {

        const arcgisMap = document.querySelector("arcgis-map");

        arcgisMap.addEventListener("arcgisViewReadyChange", () => {

        });

      });

    </script>
Expand

Define service url

Use the locator module to access the Geocoding service and the reverseGeocode operation.

Define a variable, serviceUrl, to reference the Geocoding service.

Expand
Use dark colors for code blocks
        arcgisMap.addEventListener("arcgisViewReadyChange", () => {

          const serviceUrl = "http://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer";

        });
Expand

Reverse geocode

Use an event listener to capture a click location on the map and then call the Geocoding service. The service returns an address if an address is found, or an error if it cannot find a result. Display the results in a pop-up with the latitude, longitude, and address.

In the arcgisViewReadyChange event listener, add an arcgisViewClick event handler to the map component. Create params and set the location to evt.detail.mapPoint.

Expand
Use dark colors for code blocks
          const serviceUrl = "http://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer";

          arcgisMap.addEventListener("arcgisViewClick", (evt) => {
            const params = {
              location: evt.detail.mapPoint
            };

          });
Expand

Create a showAddress function to display coordinates and the corresponding address within a pop-up.

Expand
Use dark colors for code blocks
          arcgisMap.addEventListener("arcgisViewClick", (evt) => {
            const params = {
              location: evt.detail.mapPoint
            };

          });

          function showAddress(address, pt) {
            arcgisMap.openPopup({
              title: +Math.round(pt.longitude * 100000) / 100000 + ", " + Math.round(pt.latitude * 100000) / 100000,
              content: address,
              location: pt
            });
          }
Expand

Update the arcgisViewClick handler to call locationToAddress to reverse geocode the mapPoint. Use the showAddress function to display a pop-up with the results.

Expand
Use dark colors for code blocks
          arcgisMap.addEventListener("arcgisViewClick", (evt) => {
            const params = {
              location: evt.detail.mapPoint
            };

            locator.locationToAddress(serviceUrl, params).then(
              (response) => {
                // Show the address found
                const address = response.address;
                showAddress(address, evt.detail.mapPoint);
              },
              (error) => {
                // Show no address found
                showAddress("No address found.", evt.detail.mapPoint);
              }
            );

          });
Expand

Run the App

In CodePen, run your code to display the map.

Click on the map to reverse geocode a location and return a pop-up with the closest address.

What's next?

Learn how to use additional API features and ArcGIS services in these tutorials: