Find a route and directions

Learn how to access the routing service.

Routing is the process of finding the path from an to a in a street network. You can use the to find , get driving directions, calculate drive times, and solve complicated, multiple vehicle routing problems. To create a route, you typically define a set of stops (origin and one or more destinations) and use the service to find a route with directions. You can also use a number of additional parameters such as barriers and mode of travel to refine the results.

In this tutorial, you find a route and directions for an origin and destination by accessing the .

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 in your for the type of authentication you selected.

Create a new with the correct privileges to access the resources used in this tutorial.

  1. Go to the Create an API key tutorial and create an with the following :
    • Privileges:
      • Location services > Routing
  2. Copy the API key access token to your clipboard when prompted.

Set developer credentials

Use the API key or OAuth so your application can access .

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

    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 Routing service.

  1. Reference the arcgis-rest-request and arcgis-rest-routing libraries either through CDN, ES Modules, or Node JS.

  2. Define the parameters needed for the request.

  3. Call the and handle the results.

Expand
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
  <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_URI", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    arcgisRest
      .solveRoute({
        stops: [
          [-117.195677, 34.056383],
          [-117.918976, 33.812092]
        ],
        authentication
      })
      .then((response) => {
        console.log(response);
        document.getElementById("result").textContent = JSON.stringify(response, 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.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close