Introduction to geocoding and search

Geocoding, also known as address search, is the process of converting text for an address or place to a complete address with a location. You can use the geocoding service to search for an address or a place, find candidate matches, and return complete addresses with a location.

With the service, you can build applications to:

  • Find the location of an address.
  • Convert address text to a complete address.
  • Provide a list of address candidates for an incomplete address.

How to access the geocoding service

There is no direct integration with MapLibre GL JS to access the geocoding service. Instead, you use the geocoding and request packages to make an authenticated request to the service.

The typical steps for accessing the service with ArcGIS REST JS is to:

  1. Reference the appropriate package.
  2. Set the API key to authenticate the request.
  3. Define parameters to pass to the service.
  4. Call the service and handle the results.

Example

Search for an address

This example shows how to search for an address using the geocode operation from ArcGIS REST JS.

Use dark colors for code blocksCopy
                         
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
<script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>
<script src="https://unpkg.com/@esri/arcgis-rest-geocoding@4.0.0/dist/bundled/geocoding.umd.js"></script>
<script>

const authentication = arcgisRest.ApiKeyManager.fromKey("YOUR_API_KEY");

arcgisRest
  .geocode({
    singleLine: query,
    authentication,
    params: {
      location: map.getCenter().toArray().join(","), // center of map as longitude,latitude
      outFields: "*" // return all fields
    }
  })
  .then((response) => {
    const result = response.candidates[0];
    const lngLat = [result.location.x, result.location.y];
    new maplibregl.Popup()
      .setLngLat(lngLat)
      .setHTML(result.attributes.LongLabel)
      .addTo(map);
  });

</script>

To learn more, go to the Search for an address tutorial.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.