Find a route and directions

Learn how to find a route and directions with the route service.

Find a route and directions using API key authentication.

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 use ArcGIS REST JS to access the routing service to get route. You click on the map to get an origin and destination that are used to get a route and directions from the route service. The directions are also displayed on the map.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

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

You can choose one of the following to create a new CodePen:

Option 1: Complete the Display a map tutorial; or,
Option 2: Start from the Display a map tutorial .

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.

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps
  - Location services > Routing
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.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN"
Expand

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL with the client ID and redirect URL of your OAuth credentials.

index.html
Use dark colors for code blocks
    /* Use for user authentication */
    const session = 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
    })

callback.html
Use dark colors for code blocks
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      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
    })

Run the app and ensure you can sign in successfully.

If you are unable to sign in, make sure you have the correct redirect URL and port. This URL varies based on your application and typically takes the format of https://<server>[:port]/callback.html or http://my-arcgis-app:/auth. For example, if you are running an application on http://127.0.0.1:5500/, set http://127.0.0.1:5500/callback.html as your redirect URL in the index.html and callback.html file and your developer credential. They all have to match!

Add references to ArcGIS REST JS

In the <head> element, add references to the ArcGIS REST JS library.

Expand
Use dark colors for code blocks

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
  <script src=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.js></script>
  <link href=https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.css rel="stylesheet" />

  <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
  <script src="https://unpkg.com/@esri/arcgis-rest-routing@4/dist/bundled/routing.umd.js"></script>


  <style>
    html,
    body,
    #map {
      padding: 0;
      margin: 0;
      height: 100%;
      width: 100%;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }


  </style>

</head>
Expand

Update the map

A navigation basemap layer is typically used in geocoding and routing applications. Update the basemap layer to use arcgis/navigation.

Update the basemap and the map initialization to center on location [-79.3832,43.6532], Toronto.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN";

    // or

    /* Use for user authentication */
    // const session = 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: "YOUR_PORTAL_URL" // Your portal URL
    // })

    // const accessToken = session.token;

    const basemapEnum = "arcgis/navigation";

    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,
      zoom: 12, // starting zoom

      center: [-79.3832, 43.6532] // Toronto

    });
Expand

Add end point layers

To display circles for the start and end of the route, you will two circle layers. Each layer needs a GeoJSON source which holds the data.

Create a function called addCircleLayers.

Expand
Use dark colors for code blocks
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,
      zoom: 12, // starting zoom

      center: [-79.3832, 43.6532] // Toronto

    });

    function addCircleLayers() {

    }
Expand

Add a GeoJSON source for the start and end, with ids route-start and route-end. Set the data attribute of each source to be an empty FeatureCollection.

This source will later contain the geometry information of the start or end point that the user has selected. For now, you can simply provide it with an empty piece of GeoJSON: a feature collection that contains no features.

Expand
Use dark colors for code blocks
    function addCircleLayers() {

      map.addSource("start", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });
      map.addSource("end", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });

    }
Expand

Add a layer of type circle for the start and end, connected to those sources. Use the circle-color paint property to make the start circle white and the end circle black.

Each layer will display the data in its source. Since there is no data in those sources for now, nothing will display yet.

Expand
Use dark colors for code blocks
    function addCircleLayers() {

      map.addSource("start", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });
      map.addSource("end", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });

      map.addLayer({
        id: "start-circle",
        type: "circle",
        source: "start",
        paint: {
          "circle-radius": 6,
          "circle-color": "white",
          "circle-stroke-color": "black",
          "circle-stroke-width": 2
        }
      });

      map.addLayer({
        id: "end-circle",
        type: "circle",
        source: "end",
        paint: {
          "circle-radius": 7,
          "circle-color": "black"
        }
      });

    }
Expand

Add a load event handler

At this stage, the layers have not been added to the map. It is important to wait for the map to finish loading before adding the layers.

Add an event handler to the map load event. Call the addCircleLayers function.

Expand
Use dark colors for code blocks
      map.addLayer({
        id: "end-circle",
        type: "circle",
        source: "end",
        paint: {
          "circle-radius": 7,
          "circle-color": "black"
        }
      });

    }

    map.on("load", () => {
      addCircleLayers();

      addRouteLayer();

    });
Expand

Add a click handler

You will click twice to set a start and end for the route. The first click will update the start source. The second click will update the end source. To set the GeoJSON data you use map.getSource to get the Source, then call setData.

You use a click event handler to respond to these clicks.

The object passed to the click event contains several useful properties, including:

lngLat: the map location where the click took place.
point: the screen location in pixels where the click took place.
originalEvent: the DOM event, which contains information about modifier keys.

For more information, see the MapLibre GL JS documentation.

Add a variable to store whether the next click will be for the start or end of the route. Set it initially to start. Add a variable to store the coordinates for each end.

Expand
Use dark colors for code blocks
    map.on("load", () => {
      addCircleLayers();

      addRouteLayer();

    });

    let currentStep = "start";
    let startCoords, endCoords;
Expand

Add a click event handler to the map. Use the lngLat property of the event parameter to create a GeoJSON Point object.

Expand
Use dark colors for code blocks
    let currentStep = "start";
    let startCoords, endCoords;

    map.on("click", (e) => {

      const coordinates = e.lngLat.toArray();
      const point = {
        type: "Point",
        coordinates
      };

    });
Expand

Use map.getSource and the setData method to update the correct source with the GeoJSON object.

Expand
Use dark colors for code blocks
    map.on("click", (e) => {

      const coordinates = e.lngLat.toArray();
      const point = {
        type: "Point",
        coordinates
      };

      if (currentStep === "start") {
        map.getSource("start").setData(point);
        startCoords = coordinates;
        const empty = {
          type: "FeatureCollection",
          features: []
        };
        map.getSource("end").setData(empty);
        map.getSource("route").setData(empty);
        endCoords = null;
        currentStep = "end";
      } else {
        map.getSource("end").setData(point);
        endCoords = coordinates;
        currentStep = "start";
      }

    });
Expand

At the top right, click Run. You should be able to click in two places to set a white circle for the start, and a black circle for the end.

Add route layer

The route object that will be retrieved is a GeoJSON LineString object. To display it, you define a GeoJSON source and a line layer.

Create a addRouteLayer function. Inside, add a source of type geojson with id route. Set its data attribute to be an empty FeatureCollection.

Expand
Use dark colors for code blocks
      map.addLayer({
        id: "end-circle",
        type: "circle",
        source: "end",
        paint: {
          "circle-radius": 7,
          "circle-color": "black"
        }
      });

    }

    function addRouteLayer() {

      map.addSource("route", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });

    }
Expand

Add a layer of type line with id route-line. Set its source to be route, and give it width, color and opacity attributes.

This source will later contain the geometry information of the route between points that the user has selected. For now, you can simply provide it with an empty piece of GeoJSON: a feature collection that contains no features.

The layer will display the source. Since there is no data in the source for now, nothing will display yet.

Expand
Use dark colors for code blocks
    function addRouteLayer() {

      map.addSource("route", {
        type: "geojson",
        data: {
          type: "FeatureCollection",
          features: []
        }
      });

      map.addLayer({
        id: "route-line",
        type: "line",
        source: "route",

        paint: {
          "line-color": "hsl(205, 100%, 50%)",
          "line-width": 4,
          "line-opacity": 0.6
        }
      });

    }
Expand

Get the route

To find the route, you use ArcGIS REST JS to call the solveRoute function to access the route service. Make sure to warn the user if there is a problem accessing the service.

To update the route source with the result, get the Source with map.getSource to get the Source, then call setData.

Create a function called updateRoute. Inside, create a new ApiKeyManager to access the route service. Call solveRoute with the two sets of coordinates as a stops array.

Expand
Use dark colors for code blocks
        paint: {
          "line-color": "hsl(205, 100%, 50%)",
          "line-width": 4,
          "line-opacity": 0.6
        }
      });

    }

    function updateRoute() {

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

      arcgisRest
        .solveRoute({
          stops: [startCoords, endCoords],
          endpoint: "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve",
          authentication
        })

    }
Expand

Create a response handler. Inside, use the setData method to update the route source's geometry from the response's routes.geojson property.

Expand
Use dark colors for code blocks
      arcgisRest
        .solveRoute({
          stops: [startCoords, endCoords],
          endpoint: "https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve",
          authentication
        })

        .then((response) => {
          map.getSource("route").setData(response.routes.geoJson);

        })

Expand

Add an error handler. Show a message and log a message if there is a problem.

Expand
Use dark colors for code blocks
        .then((response) => {
          map.getSource("route").setData(response.routes.geoJson);

        })

        .catch((error) => {
          console.error(error);
          alert("There was a problem using the route service. See the console for details.");
        });
Expand

Update the click handler

If the start and end coordinates have been set by the user, you can now call your updateRoute function.

Check that the start and end coordinates have been set. Then call updateRoute.

Expand
Use dark colors for code blocks
    map.on("click", (e) => {

      const coordinates = e.lngLat.toArray();
      const point = {
        type: "Point",
        coordinates
      };

      if (currentStep === "start") {
        map.getSource("start").setData(point);
        startCoords = coordinates;
        const empty = {
          type: "FeatureCollection",
          features: []
        };
        map.getSource("end").setData(empty);
        map.getSource("route").setData(empty);
        endCoords = null;
        currentStep = "end";
      } else {
        map.getSource("end").setData(point);
        endCoords = coordinates;
        currentStep = "start";
      }

      if (startCoords && endCoords) {
        updateRoute(startCoords, endCoords);
      }

    });
Expand

Show directions

The data returned from the route service contains directions information. To display it, you can create a styled <div> element. You will populate this with data drawn from the directions attribute of the response.

In the <body>, add a <div> element with an id of directions.

Expand
Use dark colors for code blocks

<body>
  <div id="map"></div>

  <div id="directions">Click on the map to create a start and end for the route.</div>

Expand

In the <style> section, style the #directions element with absolute position so it sits in front of the map, and a fixed width and height.

Expand
Use dark colors for code blocks
  <style>
    html,
    body,
    #map {
      padding: 0;
      margin: 0;
      height: 100%;
      width: 100%;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }


    #directions {
      position: absolute;
      width: 30%;
      max-height: 50%;
      right: 20px;
      top: 20px;
      overflow-y: auto;
      /* Show a scrollbar if needed */
      background: white;
      font-family: Arial, Helvetica, Verdana;
      line-height: 1.5;
      font-size: 14px;
      padding: 10px;
    }


  </style>
Expand

In the query response handler, set the contents of the <div> element using the directions attribute. Join the text attributes of each element of the features array to make the HTML contents of the <div> element. Use <br> tags between each line to create a line break.

The directions element is an array where each element corresponds to one route. Its features attribute is an array with information about each step on the route, including the length of the maneuver, the kind of maneuver, and the text that should be shown to the user.

Expand
Use dark colors for code blocks
        .then((response) => {
          map.getSource("route").setData(response.routes.geoJson);

          const directionsHTML = response.directions[0].features.map((f) => f.attributes.text).join("<br/>");
          document.getElementById("directions").innerHTML = directionsHTML;

        })

        .catch((error) => {
          console.error(error);
          alert("There was a problem using the route service. See the console for details.");
        });
Expand

Run the app

Run the app.

When the map displays, you should be able to click on it once to create an origin point and again to create a destination point. The routing service should then display the resulting route and turn-by-turn directions.

What's next?

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

Reverse geocode

Find an address near a location with the Geocoding service.

Find nearby places and details

Find points of interest near a location and get detailed information about them

Find service areas

Calculate the area that can be reached in a given driving time from a location.