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

You need an ArcGIS account to access the developer dashboard and create an API key.

Steps

Create a new pen

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

Get an API Key

To access location services, you need an API key or OAuth 2.0 access token.

  1. Go to your dashboard to get an API key. The API key must be scoped to access the services used in this tutorial.
  2. In CodePen, update apiKey to use your key.

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. Set the apiKey with the API key from your dashboard.

  3. Define the parameters needed for the request.

  4. Call the Geocoding service and handle the results.

CDNES ModulesNode JS
                                                     
Add line.Change lineAdd line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.
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
<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width">
  <title>ArcGIS REST JS</title>
  <style>
    body {
      font-family: monospace;
      color: white;
      overflow: auto;
      padding: 1rem;
    body,pre{
      background: #000000;
  </style>
</head>
<body>
  <pre id="result"></pre>

  <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
  <script src="https://unpkg.com/@esri/arcgis-rest-request@3.0.0/dist/umd/request.umd.js"></script>
  <script src="https://unpkg.com/@esri/arcgis-rest-auth@3.0.0/dist/umd/auth.umd.js"></script>
  <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@3.0.0/dist/umd/geocoding.umd.js"></script>

  <script>
    /* when including ArcGIS REST JS all exports are available
    from the same arcgisRest global */

    const apiKey = "YOUR_API_KEY";

    const authentication = new arcgisRest.ApiKey({
      key: apiKey
    });

    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>

</body>
</html>

Result

The request will return the following :

What's next?

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

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