Find a route and directions

Routing is the process of finding the path from an origin to a destination in a street network. You can use the route service to find routes, 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 route service.

Prerequisites

You need a free ArcGIS developer account to access your dashboard and API keys. The API key must be scoped to access the services used in this tutorial.

Steps

Create a new pen

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

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 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 Routing 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.Add line.
                                                     
<!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;
    }
    pre {
      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-routing@3.0.0/dist/umd/routing.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.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>

</body>
</html>

Result

The request will return the following :

What's next?

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