Find place addresses

Learn how to access the geocoding service.

Find places

Find places using API key authentication

Place finding is the process of searching for a place name or POI to find its address and location.

In this tutorial, you use the Geocoding service to find coffee shops within a specified location and distance.

Prerequisites

Steps

Get the starter app

Select a type of authentication below and follow the steps to create a new application.

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

Set up authentication

Create developer credentials in your portal for the type of authentication you selected.

Create a new API key credential 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.

Set developer credentials

Use the API key or OAuth developer credentials so your application can access location services.

  1. Update the accessToken variable to use your API key.

    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
        const accessToken = "YOUR_ACCESS_TOKEN";
    

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-request and arcgis-rest-geocoding libraries either through CDN, ES Modules, or Node JS.

  2. Define the parameters needed for the request.

  3. Call the Geocoding service and handle the results.

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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
  <script>
    /* when including ArcGIS REST JS all exports are available
  from the same arcgisRest global */
    /* Use for API key authentication */

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

    // or

    /* Use for user authentication */
    // const authentication = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
    //   clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
    //   redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    arcgisRest
      .geocode({
        params: {
          category: "Coffee shop",
          location: "144.9850916862488,-37.798297645411",
          maxLocations: 20
        },
        outFields: "*",
        authentication
      })
      .then((response) => {
        console.log("Candidates:", response.candidates);
        document.getElementById("result").textContent = JSON.stringify(response.candidates, null, 2);
      });

  </script>
Expand

Run the app

Run the app.

The result should look similar to this.

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.