Find place addresses

Learn how to search for coffee shops, gas stations, restaurants and other nearby places with the geocoding service.

Place addresses for businesses by category with the geocoding service using API key authentication

Place finding is the process of searching for a place name or POI to find its address and location. You can use the geocoding service to find places such as coffee shops, gas stations, or restaurants for any geographic location around the world. You can search for places by name or by using categories. You can search near a location or you can search globally.

In this tutorial, you use ArcGIS REST JS to access the geocoding service and find places by place category.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

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

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 developer credentials in your portal for the type of authentication you selected.

Create a new API key credential with the correct privileges to access the resources 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
Copy the API key access token to your clipboard when prompted.

Set developer credentials

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

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN"
Expand

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 session = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

callback.html
Use dark colors for code blocks
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // 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!

Add API references

This tutorial uses ArcGIS REST JS for place finding.

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

Expand
Use dark colors for code blocks

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
  <script src=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.css rel="stylesheet" />

  <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
  <script
    src="https://unpkg.com/@esri/arcgis-rest-geocoding@4/dist/bundled/geocoding.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;
    }

    .places {
      position: absolute;
      top: 20px;
      left: 20px;
    }
  </style>

</head>
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 and the map initialization to center on location [-122.4194,37.7749], San Francisco.

Expand
Use dark colors for code blocks
  <script>
    /* 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_URL", // 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 = new maplibregl.Map({
      container: "map",
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,
      zoom: 13,

      center: [-122.4194, 37.7749] // San Francisco

    });
Expand

Add controls

Use a select element to create the drop-down element. Each category is an option element inside it. The select element needs to have absolute positioning in order to appear in front of the map element.

Add a select control, with options for "Coffee shop", "Gas station", "Food", "Hotel", "Parks and outdoors". Use inline styling to position the control.

The option values have special meaning to the geocoding service so ensure the spelling is correct. To learn more, go to Category filtering in the ArcGIS services reference.

Expand
Use dark colors for code blocks

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

  <select id="places-select" style="left: 20px; top: 20px; position: absolute; font-size: 16px; padding: 4px 8px">
    <option value="">Choose a category...</option>
    <option value="Coffee shop">Coffee shops</option>
    <option value="Gas station">Gas stations</option>
    <option value="Food">Food</option>
    <option value="Hotel">Hotels</option>
    <option value="Parks and Outdoors">Parks and Outdoors</option>
  </select>
Expand

At the top right, click Run to verify that the select control is created and contains the different categories.

Add a load event handler

You need to wait for the map to be completely loaded before adding any layers.

Add an event handler to the map load event.

Expand
Use dark colors for code blocks
  <script>
    /* 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_URL", // 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 = new maplibregl.Map({
      container: "map",
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,
      zoom: 13,

      center: [-122.4194, 37.7749] // San Francisco

    });

    map.once("load", () => {

    });

    // Add Esri attribution
    // Learn more in https://esriurl.com/attribution
    map._controls[0].options.customAttribution += " | Powered by Esri "
    map._controls[0]._updateAttributions()

  </script>
Expand

Add a map layer

To display data on the map, there must be a source that contains the data, and a layer that determines how the source will be shown.

Add a geojson source that will contain the returned results. Set its data attribute to be an empty GeoJSON FeatureCollection.

Expand
Use dark colors for code blocks
    map.once("load", () => {

      map.addSource("places", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });

    });
Expand

Add a circle layer that will display the source.

The geojson source must have data provided. You can give it a FeatureCollection that does not contain any features. You will provide data later.

Expand
Use dark colors for code blocks
    map.once("load", () => {

      map.addSource("places", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });

      map.addLayer({
        id: "places-circle",
        source: "places",
        type: "circle",

        paint: {
          "circle-color": "hsla(200, 80%, 80%, 0.7)",
          "circle-stroke-color": "hsl(200, 80%, 40%)",
          "circle-stroke-width": 1,
          "circle-radius": 3
        }
      });

    });
Expand

Call the geocoding service

You can use the arcgisRest.geocode function to retrieve places near a location. Use map.getCenter to obtain the center of the viewport in longitude and latitude.

You will also pass the category selected by the user. Use document.getElementById to get the control, then use its value property.

Create a function called showPlaces. Inside, create a new arcgisRest.ApiKeyManager to access the geocoding service. Call arcgisRest.geocode() to set the API key and to call the service endpoint. A location with Place_addr and PlaceName information will be returned based on the category selected. A maximum of 25 locations will display nearest to the center of the map.

Expand
Use dark colors for code blocks
        paint: {
          "circle-color": "hsla(200, 80%, 80%, 0.7)",
          "circle-stroke-color": "hsl(200, 80%, 40%)",
          "circle-stroke-width": 1,
          "circle-radius": 3
        }
      });

    });

    function showPlaces() {

      const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

      const category = document.getElementById("places-select").value;
      if (!category) {
        return;
      }
      arcgisRest
        .geocode({
          authentication,
          outFields: "Place_addr,PlaceName",

          params: {
            category,
            location: map.getCenter().toArray().join(","),
            maxLocations: 25
          }
        })

    }
Expand

Display results

The geoJson property of the response object contains a GeoJSON feature collection of points. You can use this to update the data of your places source.

Add a response handler. Inside, use the map's setData method to set the returned value as GeoJSON.

Expand
Use dark colors for code blocks
          params: {
            category,
            location: map.getCenter().toArray().join(","),
            maxLocations: 25
          }
        })

        .then((response) => {
          map.getSource("places").setData(response.geoJson);
        })
Expand

Handle errors

It is good practice to handle situations where there is a problem accessing the service. This could happen due to network disruption or a problem with your API key, for instance.

If there is an exception accessing the geocoding service, alert the user and log the error.

Expand
Use dark colors for code blocks
        .then((response) => {
          map.getSource("places").setData(response.geoJson);
        })

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

    }
Expand

Add a change event handler

To update the map when the user chooses a category, you must add an event handler for the change event on the <select> control.

Update the load event handler to call the showPlaces() function.

Expand
Use dark colors for code blocks
      map.addLayer({
        id: "places-text",
        source: "places",
        type: "symbol",
        layout: {
          "text-field": ["get", "PlaceName"],
          "text-font": ["Arial Bold"],
          "text-variable-anchor": ["left", "right"],
          "text-justify": "left",
          "text-radial-offset": 0.5
        },
        paint: {
          "text-color": "hsl(200, 80%,40%)",
          "text-halo-color": "white",
          "text-halo-width": 2
        }
      });

      showPlaces();
Expand

After the map initialization code, make the <select> control control call showPlaces() when the user chooses an option.

Expand
Use dark colors for code blocks
        .catch((error) => {
          alert("There was a problem using the geocoder. See the console for details.");
          console.error(error);
        });

    }

    document.getElementById("places-select").addEventListener("change", showPlaces);
Expand

At the top right, click Run. When you choose a place category, circles should be shown for places.

Display place labels

You can show the name of each location by using a symbol layer with text properties.

In the load handler, add a symbol layer.

It is important to use a font whose glyphs are present within the map style. This style contains several variants of Arial, which makes that a safe choice.

By default, MapLibre GL JS centers text labels over their center point. Since there is a circle showing already, it is better to treat the point as the left anchor, and also set a text-justify of `left.

When labels are close together, not all will be shown. You could change the default settings of text-allow-overlap if you want to alter this behavior.

For more information about available style properties, see the MapLibre GL JS documentation.

Expand
Use dark colors for code blocks
      map.addLayer({
        id: "places-circle",
        source: "places",
        type: "circle",

        paint: {
          "circle-color": "hsla(200, 80%, 80%, 0.7)",
          "circle-stroke-color": "hsl(200, 80%, 40%)",
          "circle-stroke-width": 1,
          "circle-radius": 3
        }
      });

      map.addLayer({
        id: "places-text",
        source: "places",
        type: "symbol",
        layout: {
          "text-field": ["get", "PlaceName"],
          "text-font": ["Arial Bold"],
          "text-variable-anchor": ["left", "right"],
          "text-justify": "left",
          "text-radial-offset": 0.5
        },
        paint: {
          "text-color": "hsl(200, 80%,40%)",
          "text-halo-color": "white",
          "text-halo-width": 2
        }
      });

      showPlaces();
Expand