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, you 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.

In this tutorial, you use the reverseGeocode method of ArcGIS REST JS to reverse geocode and find the closest address to your clicked location on the map.

Prerequisites

You need a free ArcGIS developer account to access your dashboard and API keys. The API key must be scoped to access the services used in this tutorial.

Steps

Create a new pen

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

Set the API key

To access ArcGIS location services, you need an API key.

Go to your dashboard to get an API key.

In CodePen, update apiKey to use your key.

Change line
//

const apiKey = "YOUR-API-KEY";
const basemapEnum = "ArcGIS:Streets";
const map = new mapboxgl.Map({
  container: "map", // the id of the div element
  style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
  zoom: 12, // starting zoom
  center: [-118.805, 34.027] // starting location [longitude, latitude]
});

Add references to ArcGIS REST JS

This tutorial uses ArcGIS REST JS for reverse geocoding.

In the <head> element, add references to the ArcGIS REST JS library.

Add line.Add line.Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Update the map

A navigation basemap layer is typically used in geocoding and routing applications. Update the basemap layer to use ArcGIS:Navigation.

Update the basemap and the map initialization to center on location [2.3522,48.8566], Paris.

Change lineChange line

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Add a click event handler

Before you call the Geocoding service, you need to get a location from the user. You can add a handler to the Map's click event. The click handler will be called with an object containing parameters such as lngLat.

The lngLat property is a LngLat. It has lng and lat properties and a toArray method which returns an array in [longitude, latitude] order.

After the map initialization code, add a handler for the click event. Create a coordinates array from the lngLat property of the event parameter.

Add line.Add line.Add line.Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Call the service

Use the ArcGIS REST JS reverseGeocode method to find an address closest to a point.

Inside the click handler, create a new arcgisRest.ApiKey to access the geocoding service. Call the arcgisRest.reverseGeocode method with the coordinates array.

Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Display the result

The response from the reverseGeocode operation contains two properties. address is a structured object with fields such as street name and business name. location contains the location of the returned address, which may differ from the coordinates you provided.

Use the results to display a pop-up with the address and location values.

Convert the result.location object into an array of [longitude, latitude].

Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Set a variable containing the text you want to display, using the address and coordinates.

Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Add a pop-up to display the label at the returned coordinates.

To add a pop-up to the map, you use the Popup class in Mapbox GL JS. See the Display a pop-up tutorial for more information.

Add line.Add line.Add line.Add line.Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Handle errors

To handle errors that occur when accessing the Geocoding service, such as networking or API key issues, use an error handler to show a message to the user.

Add a handler to catch any exception and display a message to the user.

Add line.Add line.Add line.Add line.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.js"></script>
    <link href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.12.0/mapbox-gl.css" rel="stylesheet" />

    <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>

    <style>
      html,
      body,
      #map {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
        font-family: Arial, Helvetica, sans-serif;
        font-size: 14px;
        color: #323232;
      }
    </style>

  </head>

  <body>
    <div id="map"></div>

  </body>

  <script>

    const apiKey = "YOUR-API-KEY";

    const basemapEnum = "ArcGIS:Navigation";

    const map = new mapboxgl.Map({
      container: "map",
      style: `https://basemaps-api.arcgis.com/arcgis/rest/services/styles/${basemapEnum}?type=style&apiKey=${apiKey}`,
      zoom: 12,

      center: [2.3522,48.8566] // Paris

    });

    map.on("click", (e) => {
      const coords = e.lngLat.toArray();

      const authentication = new arcgisRest.ApiKey({
        key: apiKey
      });

      arcgisRest
        .reverseGeocode(coords, {
          authentication
        })
        .then((result) => {

          const lngLat = [result.location.x, result.location.y];

          const label = `${result.address.LongLabel}<br>${lngLat[0].toLocaleString()}, ${lngLat[1].toLocaleString()}`;

          new mapboxgl
            .Popup()
            .setLngLat(lngLat)
            .setHTML(label)
            .addTo(map);

          })

        .catch((error) => {
          alert("There was a problem using the reverse geocode service. See the console for details.");
          console.error(error);
        });

    });

  </script>

</html>

Run the app

In CodePen, run your code to display the map.

Click on the map to reverse geocode the clicked point and display a pop-up with the closest address and coordinates.

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Find places

Search for coffee shops, gas stations, restaurants and other nearby places with the Geocoding service.

Find service areas

Calculate the area that can be reached in a given driving time from a location.

Find a route and directions

Find a route and directions with the route service.

PreviousSearch for an address NextFind places

DocumentationMapbox GL JS Guide

Reverse geocode

Solution

Estimated time

Was this page helpful?

Solution

Estimated time

Was this page helpful?

Was this page helpful?