Search with autosuggest | MapLibre GL JS

Learn how to search for an address with autosuggest.

Search for addresses with autosuggest using API key authentication

The ArcGIS Geocoding serviceA geocoding service is a service that can search for addresses, place addresses, businesses, reverse geocode coordinates to addresses, provide suggestions for places, and perform bulk geocoding. It is hosted by Esri as the ArcGIS Geocoding service and can also be hosted in ArcGIS Enterprise.Learn more allows to search for an address or a place with autosuggest. Autosuggest, also known as autocomplete, is a feature that predicts and displays location-based suggestions as a user types into a search box.

In this tutorial, use the MapLibre ArcGIS plugin to display a map and ArcGIS REST JS to access the ArcGIS Geocoding serviceA geocoding service is a service that can search for addresses, place addresses, businesses, reverse geocode coordinates to addresses, provide suggestions for places, and perform bulk geocoding. It is hosted by Esri as the ArcGIS Geocoding service and can also be hosted in ArcGIS Enterprise.Learn more. You also create an input control to accept text and suggest address results. When a suggestion is selected, a pop-up will appear with the name, locationA location is a position or region (point, line, or polygon) on the earth's surface.Learn more, and address, and the map will pan to it.

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 applicationsA public application is an application that allows anonymous access without requiring users to sign in with an ArcGIS account. It supports API key or app authentication.Learn more that access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more and secure itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
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 accountAn ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription.Learn more 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 credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

Go to the Create an API key tutorial to follow the steps to get an access token with these privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
- Privileges
  - Location services > Basemaps
  - Location services > Geocoding

Create a new OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to register the application.

Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

Set developer credentials

Use the API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access ArcGIS servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocksCopy
    /* 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 credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

index.html
Use dark colors for code blocksCopy
    /* 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 blocksCopy
    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!

Add script references

In the <head> element, add references to the ArcGIS REST JS request and geocoding libraries.

Use dark colors for code blocks
    <!-- Load MapLibre GL JS from CDN -->
    <script src="https://unpkg.com/maplibre-gl@5.23.0/dist/maplibre-gl.js"></script>
    <link href="https://unpkg.com/maplibre-gl@5.23.0/dist/maplibre-gl.css" rel="stylesheet">
    <!-- Load MapLibre ArcGIS from CDN -->
    <script src="https://unpkg.com/@esri/maplibre-arcgis@1.1.0/dist/umd/maplibre-arcgis.min.js"></script>

    <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>

Update the map

An arcgis/navigation basemap styleA basemap style is a definition that controls the visual appearance of how geographic data in a basemap are displayed. It includes colors, backgrounds, outlines, labels, and other visual elements. Each basemap style emphasizes a specific type of cartographic theme and data.Learn more is typically used in geocoding and routing applications. Update the basemap layer to use the style.

Update the basemap and initialize the map to center on the coordinates [-123.102, 49.234] with a zoom level of 11. This will center the map on Vancouver.

Expand
Use dark colors for code blocksCopy
    const map = new maplibregl.Map({
      container: "map",

      zoom: 11,
      center: [-123.102, 49.234] // Vancouver

    });

    const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
      style: "arcgis/navigation",
      token: accessToken
    });
Expand

Create geocoding controls

Create an HTML <div> containing an <input> for typing an address and a <button> to clear the input. Implement this <div> as a as a Map control using the IControl interface. Then, in the <body> of your HTML, add a <ul> element to display address suggestions as the user types.

In the <body> of your HTML, add a <ul> element with the id suggestions.

Use dark colors for code blocks
    <div id="map"></div>

    <ul id="suggestions"></ul>

Create a GeocodeControl class with an onAdd function. Inside, create a <div> element with an <input> and a <button> inside. Then, add the geocodeControl element to the top-left of the view.

Expand
Use dark colors for code blocks
    class GeocodeControl {
      onAdd() {
        const container = document.createElement("div");
        container.className = "maplibregl-ctrl maplibregl-ctrl-group";

        container.innerHTML = `
          <div id="geocode-container">
            <input id="geocode-input" type="text" placeholder="Type an address" autocomplete="off" />
            <button id="clear-button">&times;</button>
          </div>
        `;

        return container;
      }
    }

    map.addControl(new GeocodeControl(), "top-left");
Expand

Add styling to the controls.

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

    #geocode-container {
      display: flex;
      align-items: center;
    }

    #geocode-input {
      padding: 4px 8px;
      width: 20vw;
    }

    #clear-button {
      border: none;
      color: #666;
      cursor: pointer;
      background-color: #fff;
    }

    #suggestions {
      display: none;
      position: absolute;
      top: 40px;
      left: 10px;
      background: white;
      list-style: none;
      padding: 0;
      margin: 0;
      width: 25vw;
      z-index: 999;
    }

    #suggestions li {
      padding: 6px 8px;
      border: 1px solid transparent;
      box-sizing: border-box;
    }

    #suggestions li:hover {
      background-color: #f0f0f0;
    }

    #suggestions li.selected {
      border-color: #000000;
    }


    .maplibregl-ctrl-bottom-right {
      margin-left: 50px;
    }

    </style>

Set up interactivity for the geocoding controls by doing the following:

Handling hover styles.
Enabling keyboard navigation.
Managing suggestion visibility with clear and outside-click actions.

Expand
Use dark colors for code blocks
    const suggestionsList = document.getElementById("suggestions");
    let selectedIndex = -1;

    function updateSelection(items) {
      items.forEach((item, i) => item.classList.toggle("selected", i === selectedIndex));
    }

    input.addEventListener("keydown", (e) => {
      const items = suggestionsList.querySelectorAll("li");

      if (e.key === "ArrowDown") {
        if (selectedIndex < items.length - 1) selectedIndex++;
      } else if (e.key === "ArrowUp") {
        if (selectedIndex > 0) selectedIndex--;
      } else if (e.key === "Enter" && selectedIndex >= 0) {
        items[selectedIndex].click();
      }

      updateSelection(items);
    });

    document.getElementById("clear-button").addEventListener("click", () => {
      input.value = "";
      popup.remove();
    });

    document.addEventListener("click", (e) => {
      if (!document.getElementById("geocode-container").contains(e.target)) {
        suggestionsList.style.display = "none";
      }
    });
Expand

Get address suggestions

Use the suggest method from the geocoding service to fetch location suggestions as a user types.

Add an input event handler to capture text as a user types. Reset the selection index and hide suggestions when the input is empty.

Expand
Use dark colors for code blocks
    input.addEventListener("input", () => {
      selectedIndex = -1;
      const text = input.value;

      if (!text) return suggestionsList.style.display = "none";

    });
Expand

Use the suggest method to fetch location suggestions as the user types, then display them in a list. For each suggestion, create an <li> element, append it to the suggestions list, and make the list visible.

Expand
Use dark colors for code blocks
    input.addEventListener("input", () => {
      selectedIndex = -1;
      const text = input.value;

      if (!text) return suggestionsList.style.display = "none";

      arcgisRest.suggest(text, {
        authentication,
        params: {
          location: { x: -123.024, y: 49.274, spatialReference: { wkid: 4326 } },
          maxSuggestions: 5
        }
      }).then((response) => {
        suggestionsList.innerHTML = "";
        if (!response.suggestions || response.suggestions.length === 0) {
          suggestionsList.style.display = "none";
          return;
        }
        response.suggestions.forEach((s) => {
          const li = document.createElement("li");
          li.textContent = s.text;

          suggestionsList.appendChild(li);
        });

        suggestionsList.style.display = "block";
      });

    });
Expand

Call the `geocode` method

When the user selects a suggestion, call the geocode method to get location coordinates.

Get the input field and initialize the popup.

Expand
Use dark colors for code blocks
    const input = document.getElementById("geocode-input");
    let popup = null;
Expand

Use your access token to authenticate with ArcGIS REST JS and make requests to the geocoding service.

Expand
Use dark colors for code blocks
    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
Expand

Create a function that calls geocode using the magicKey returned by the suggest method. The magicKey helps match partial text input to a complete address. You will use this function in a later step.

Expand
Use dark colors for code blocks
    function performGeocode(magicKey) {
      arcgisRest.geocode({
        magicKey: magicKey,
        authentication
      }).then((response) => {
        const result = response.candidates[0];
        if (!result) return;

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

      });
    }
Expand

Add a click handler to each suggestion item to call the performGeocode function with the suggestion's magicKey.

Expand
Use dark colors for code blocks
          li.addEventListener("click", () => {
            input.value = s.text;
            suggestionsList.style.display = "none";
            performGeocode(s.magicKey);
          });
Expand

Show the result

Show the location details with a popup and pan the map to the location.

Expand
Use dark colors for code blocks
    function performGeocode(magicKey) {
      arcgisRest.geocode({
        magicKey: magicKey,
        authentication
      }).then((response) => {
        const result = response.candidates[0];
        if (!result) return;

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

        popup?.remove();
        popup = new maplibregl.Popup({ focusAfterOpen: false })
          .setLngLat(lngLat)
          .setHTML(`<strong>${result.address}</strong><br />${lngLat[0].toFixed(4)}, ${lngLat[1].toFixed(4)}`)
          .addTo(map);

        const bounds = [
          [result.extent.xmin, result.extent.ymin], // [south, west]
          [result.extent.xmax, result.extent.ymax] // [north, east]
        ];

        map.fitBounds(bounds, {
          padding: 20,
          animate: false
        });

      });
    }
Expand

Run the app

Run the app.

In the input box, type a partial address and see the suggestions come up. Click on a suggestion and the map will pan to the geocoded address and show a popup with the location details.

What's next?

Learn how to use additional location services in these tutorials:

Reverse geocode

Find the closest address to a clicked location on a map.

A map of San Francisco with multiple blue location markers representing nearby places.

Find place addresses

Search for places by category near a location.

Map showing a calculated driving route through downtown Toronto with turn‑by‑turn directions.

Find a route and directions

Find a route and directions from a start and finish location.