Reverse geocode | Esri Leaflet

Learn how to convert coordinates to addresses with the Geocoding service.

Reverse geocode coordinates to addresses with the Geocoding service using API key authentication

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.

Esri Leaflet provides a geocoder to access the Geocoding service. In this tutorial, you use the reverseGeocode operation to reverse geocode and find the closest address to your clicked location on the map.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

Select a type of authentication and follow the steps to create a new app.

Choose API key authentication if you:

Want the easiest way to get started.
Want to build public applications that access ArcGIS Location Services and secure items.
Have an ArcGIS Location Platform or ArcGIS Online account.

Choose user authentication if you:

Want to build private applications.
Require application users to sign in with their own ArcGIS account and access resources their behalf.
Have an ArcGIS Online account.

To learn more about both types of authentication, go to Authentication.

You can choose one of the following to create a new CodePen:

Option 1: Complete the Display a map tutorial; or,
Option 2: Start from the Display a map tutorial .

Set up authentication

Create a new API key credential with the correct privileges to get an access token.

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

Set developer credentials

Use the API key or OAuth developer credentials so your application can access ArcGIS services.

Update the accessToken variable to use your API key.

Use dark colors for code blocks
 <script>   /* Use for API key authentication */  const accessToken = "YOUR_ACCESS_TOKEN";   const map = L.map("map", {  minZoom: 2  });   </script> 

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL with the client ID and redirect URL of your OAuth credentials.

index.html
Use dark colors for code blocks
 /* Use for user authentication */  const clientId = "YOUR_CLIENT_ID"; // Your client ID from OAuth credentials  const redirectUri = ""YOUR_REDIRECT_URI""; // The redirect URL registered in your OAuth credentials  const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({  clientId,  redirectUri,  portal: "https://www.arcgis.com/sharing/rest" // Your portal URL  });   const accessToken = session.token; 

callback.html
Use dark colors for code blocks
 arcgisRest.ArcGISIdentityManager.completeOAuth2({  clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials  redirectUri: "YOUR_REDIRECT_URI", // The redirect URL registered in your OAuth credentials  portal: "https://www.arcgis.com/sharing/rest" // Your portal URL  }); 

Run the app and ensure you can sign in successfully.

If you are unable to sign in, make sure you have the correct redirect URL and port. This URL varies based on your application and typically takes the format of https://<server>[:port]/callback.html or http://my-arcgis-app:/auth. For example, if you are running an application on http://127.0.0.1:5500/, set http://127.0.0.1:5500/callback.html as your redirect URL in the index.html and callback.html file and your developer credential. They all have to match!

Reference the geocoder

Reference the Esri Leaflet Geocoder plugin.

Expand
Use dark colors for code blocks
 <!-- Load Leaflet from CDN -->  <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css" crossorigin="">  <script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js" crossorigin=""></script>  <!-- Load Esri Leaflet from CDN -->  <script src="https://unpkg.com/esri-leaflet@3.0.19/dist/esri-leaflet.js"></script>  <script src="https://unpkg.com/esri-leaflet-vector@4.3.2/dist/esri-leaflet-vector.js"></script>   <!-- Load Esri Leaflet Geocoder from CDN -->  <script src="https://unpkg.com/esri-leaflet-geocoder@3.1.6/dist/esri-leaflet-geocoder.js"></script> 
Expand

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 style and change the map view to center on location [2.3522,48.8566], Paris.

Expand
Use dark colors for code blocks
 /* Use for API key authentication */  const accessToken = "YOUR_ACCESS_TOKEN";   // or   /* Use for user authentication */  // const session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({  // clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials  // redirectUri: "YOUR_REDIRECT_URI", // The redirect URL registered in your OAuth credentials  // portal: "YOUR_PORTAL_URL" // Your portal URL  // })  // const accessToken = session.token;   const basemapEnum = "arcgis/navigation";   const map = L.map("map", {  minZoom: 2  });   map.setView([48.8566, 2.3522], 13); // Paris   L.esri.Vector.vectorBasemapLayer(basemapEnum, {  token: accessToken  }).addTo(map); 
Expand

Call the Geocoding service

Create a click handler that will call the Geocoding service when a user clicks on the map.

Expand
Use dark colors for code blocks
 L.esri.Vector.vectorBasemapLayer(basemapEnum, {  token: accessToken  }).addTo(map);   map.on("click", function (e) {   }); 
Expand

Call the reverseGeocode operation and set your accessToken. Set the latlng to the LatLng of the location where the user clicks.

reverseGeocode queries the Geocoding service by default, but can also query other Geocoding services.

Expand
Use dark colors for code blocks
 map.on("click", function (e) {   L.esri.Geocoding  .reverseGeocode({  apikey: accessToken  })  .latlng(e.latlng)   }); 
Expand

Execute the request using run and handle any errors within the callback function.

Expand
Use dark colors for code blocks
 map.on("click", function (e) {   L.esri.Geocoding  .reverseGeocode({  apikey: accessToken  })  .latlng(e.latlng)   .run(function (error, result) {  if (error) {  return;  }   });   }); 
Expand

Display the result

The response from the operation contains the location of an address or place. Use the results to display them in a Popup.

Add a LayerGroup to the map to contain reverse geocoding results. Call the clearLayers method to remove previous results.

Expand
Use dark colors for code blocks
 const layerGroup = L.layerGroup().addTo(map);   map.on("click", function (e) {   L.esri.Geocoding  .reverseGeocode({  apikey: accessToken  })  .latlng(e.latlng)   .run(function (error, result) {  if (error) {  return;  }   layerGroup.clearLayers();   });   }); 
Expand

Create a Marker at the result coordinates and add it to the layerGroup.

Expand
Use dark colors for code blocks
 const layerGroup = L.layerGroup().addTo(map);   map.on("click", function (e) {   L.esri.Geocoding  .reverseGeocode({  apikey: accessToken  })  .latlng(e.latlng)   .run(function (error, result) {  if (error) {  return;  }   layerGroup.clearLayers();   const marker = L.marker(result.latlng).addTo(layerGroup);   });   }); 
Expand

Add a lngLatString variable that stores the rounded search result coordinates. Append the bindPopup method to the marker to display the coordinates and address of the result.

To learn more about using pop-ups with Esri Leaflet, go to the Display a pop-up tutorial.

Expand
Use dark colors for code blocks
 const layerGroup = L.layerGroup().addTo(map);   map.on("click", function (e) {   L.esri.Geocoding  .reverseGeocode({  apikey: accessToken  })  .latlng(e.latlng)   .run(function (error, result) {  if (error) {  return;  }   layerGroup.clearLayers();   const marker = L.marker(result.latlng).addTo(layerGroup);   const lngLatString = `${Math.round(result.latlng.lng * 100000) / 100000}, ${Math.round(result.latlng.lat * 100000) / 100000}`;   marker.bindPopup(`<b>${lngLatString}</b><p>${result.address.Match_addr}</p>`);  marker.openPopup();   });   }); 
Expand