Search for an address

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 can also perform reverse geocoding.

In this tutorial, you find the location of an address using the Geocoding service.

Prerequisites

Steps

Create a new pen

1. If you are using the CDN libraries, use this pen to get started.

Get an access token

You need an access token with the correct privileges to access the resources used in this tutorial.

1. Go to the Create an API key tutorial and create an API key with the following privilege(s):
   

   • Privileges:
     • Location services > Geocoding

2. Copy the API key access token to your clipboard when prompted.

3. In CodePen, update the accessToken variable to use your access token.

   Use dark colors for code blocksCopy

   1
   2
   3
   4
   
   const accessToken = "YOUR_ACCESS_TOKEN";
   
   const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

To learn about the other types of authentication available, go to Types of authentication.

Make the request

Copy and paste the code below, following the steps to make a request to the Geocoding service.

1. Reference the ArcGIS REST JS libraries either through CDN, ES Modules, or Node JS.

2. 1. Set the accessToken with an API key access token from API key credentials.

3. Define the parameters needed for the request.

4. Call the Geocoding service and handle the results.

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
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <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>
      /* when including ArcGIS REST JS all exports are available
    from the same arcgisRest global */

      const accessToken = "YOUR_ACCESS_TOKEN";

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

      arcgisRest
        .geocode({
          address: "1600 Pennsylvania Ave",
          postal: 20500,
          countryCode: "USA",
          authentication
        })
        .then((response) => {
          console.log("Candidates:", response.candidates);
          document.getElementById("result").textContent = JSON.stringify(response.candidates, null, 2);
        });

    </script>

Result

Below is the response from the service:

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
[
  {
    "address": "1600 Pennsylvania Ave NW, Washington, District of Columbia, 20500",
    "location": {
      "x": -77.03654699820865,
      "y": 38.89767510765125,
      "spatialReference": {
        "wkid": 4326,
        "latestWkid": 4326
      }
    },
    "score": 99.22,
    "attributes": {},
    "extent": {
      "xmin": -77.03754699820865,
      "ymin": 38.896675107651255,
      "xmax": -77.03554699820864,
      "ymax": 38.89867510765125,
      "spatialReference": {
        "wkid": 4326,
        "latestWkid": 4326
      }
    }
  }
]

What's next?

Learn how to use additional ArcGIS location services in these tutorials: