Search for an address

Learn how to find an address or place with a search widget and the Geocoding service.

Geocoding is the process of converting address or place text into a location. The Geocoding service can search for an address or a place and perform reverse geocoding. Use the Search widget to access the Geocoding service and perform interactive searches.

In this tutorial, you will use the Search widget to search for addresses and places.

Prerequisites

Steps

Create a new pen

1. To get started, either complete the Display a map tutorial or use this pen.

Set the API key

To access ArcGIS services, you need an API key.

1. Go to your dashboard to get an API key.
2. In CodePen, set the apiKey to your key, so it can be used to access basemap layer and location services.

1
2
3
4
esriConfig.apiKey = "YOUR_API_KEY";
const map = new Map({
  basemap: "arcgis/topographic" // basemap styles service
});

Add modules

1. In the require statement, add the Search module.

   More info

   The ArcGIS Maps SDK for JavaScript is available as AMD modules and ES modules, but this tutorial is based on AMD. The AMD require function uses references to determine which modules will be loaded – for example, you can specify "esri/Map" for loading the Map module. After the modules are loaded, they are passed as parameters (e.g. Map) to the callback function where they can be used in your application. It is important to keep the module references and callback parameters in the same order. For more information on the different types of modules, visit the Introduction to Tooling guide topic.

   Expand

   Use dark colors for code blocks

   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
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
     require([
       "esri/config",
       "esri/Map",
       "esri/views/MapView",
   
       "esri/widgets/Search"
   
     ], function(esriConfig, Map, MapView, Search) {
   

   Expand

Update the map

A streets basemap layer is typically used in geocoding applications. Update the basemap property to use the arcgis/navigation basemap layer and change the position of the map to center on Seattle.

1. Update the basemap property from arcgis/topographic to arcgis/navigation.

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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
  esriConfig.apiKey = "YOUR API KEY";

  const map = new Map({
      basemap: "arcgis/navigation"
    });

1. Update the center property to [-122.3321, 47.6062] and set the zoom property to 12 to center on Seattle.

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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
  const view = new MapView({
      container: "viewDiv",
      map: map,
      center: [-122.3321,47.6062],
      zoom: 12
    });

Add a Search widget

The Search widget is a visible control that allows you to interactively search for addresses and places. It provides suggestions as you type and allows you to select a result. When you select a result, it zooms to a location and displays a pop-up with the address information. By default, the widget uses a locator and source that accesses the Geocoding service.

1. Create a Search widget. Set the view property to view.

   Expand

   Use dark colors for code blocks

   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
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
     const view = new MapView({
         container: "viewDiv",
         map: map,
         center: [-122.3321,47.6062],
         zoom: 12
       });
   
     const search = new Search({  //Add Search widget
         view: view
       });
   

   Expand

2. Add the widget to the top right corner of the view. Learn more about adding UI components to the view in DefaultUI.

   Expand

   Use dark colors for code blocks

   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
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
     const search = new Search({  //Add Search widget
         view: view
       });
   
       view.ui.add(search, "top-right"); //Add to the map
   

   Expand

Run the app

In CodePen, run your code to display the map.

Try searching for the following locations:

• Seattle
• Space Needle
• Hollywood Blvd
• 34.13419, -118.29636

The map should display a Search widget and that allows you to interactively search for addresses and places.

What's next?

Learn how to use additional API features and ArcGIS services in these tutorials:

• Reverse geocode
• Find places
• Find a route and directions
• Query a feature layer (SQL)