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 OpenLayers to access the geocoding service. Instead, you use the geocoding and request packages from ArcGIS REST JS.

To access the service with ArcGIS REST JS, you typically perform the following steps:

  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
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
    <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 query = document.getElementById("geocode-input").value;

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

        const center = ol.proj.transform(map.getView().getCenter(), "EPSG:3857", "EPSG:4326");

        arcgisRest
          .geocode({
            singleLine: query,
            authentication,

            params: {
              outFields: "*",
              location: center.join(","),
              outSR: 3857 // Request coordinates in Web Mercator to simplify displaying
            }
          })

          .then((response) => {
            const result = response.candidates[0];
            if (!result === 0) {
              alert("That query didn't match any geocoding results.");
              return;
            }

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

            popup.show(coords, result.attributes.LongLabel);
            map.getView().setCenter(coords);

          })

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