Find a route and directions | MapLibre GL JS

Learn how to find a route and directions.

Find a route and directions using API key authentication

The ArcGIS Routing serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more allows you to find routes, get driving directions, calculate drive times, and solve complicated, multiple vehicle routing problems. RoutingA simple route is the lowest cost path that visits all stops specified by the user in the order they are provided.Learn more is the process of finding the path from an originAn origin is a point that defines the start of a route.Learn more to a destinationA destination is a point that defines the final stop in a route.Learn more in a street network. 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, use the MapLibre ArcGIS plugin to display a map and ArcGIS REST JS to access the Routing service. You click on the map to get an originAn origin is a point that defines the start of a route.Learn more and destinationA destination is a point that defines the final stop in a route.Learn more that are used to get a route and directions and display it on the map.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

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

Choose API key authentication if you:

Want the easiest way to get started.
Want to build public applicationsA public application is an application that allows anonymous access without requiring users to sign in with an ArcGIS account. It supports API key or app authentication.Learn more that access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Static Maps service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more and secure itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
Have an ArcGIS Location Platform or ArcGIS Online account.

Choose user authentication if you:

Want to build private applications.
Require application users to sign in with their own ArcGIS accountAn ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription.Learn more and access resources their behalf.
Have an ArcGIS Online account.

To learn more about both types of authentication, go to Authentication.

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 a new API key credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

Go to the Create an API key tutorial to follow the steps to get an access token with these privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
- Privileges
  - Location services > Basemaps
  - Location services > Routing

Create a new OAuth credentialOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more to register the application.

Go to the Create OAuth credentials for user authentication tutorial to create an OAuth credential.
Copy the Client ID and Redirect URL from your OAuth credentials item and paste them to a safe location. They will be used in a later step.

Set developer credentials

Use the API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access ArcGIS servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more.

Update the accessToken variable to use your API key.

Expand
Use dark colors for code blocksCopy
    /* 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 credentialsOAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a client_id, client_secret, and redirect URIs. They are a type of developer credential.Learn more.

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

    const accessToken = session.token;

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

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>
    <title>MapLibre ArcGIS tutorial: Find a route and directions</title>
    <meta charset="utf-8">
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
    <!-- Load MapLibre GL JS from CDN -->
    <script src="https://unpkg.com/maplibre-gl@5.24.0/dist/maplibre-gl.js"></script>
    <link href="https://unpkg.com/maplibre-gl@5.24.0/dist/maplibre-gl.css" rel="stylesheet">
    <!-- Load MapLibre ArcGIS from CDN -->
    <script src="https://unpkg.com/@esri/maplibre-arcgis@1.3.0/dist/umd/maplibre-arcgis.min.js"></script>

    <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

An arcgis/navigation basemap styleA basemap style is a definition that controls the visual appearance of how geographic data in a basemap are displayed. It includes colors, backgrounds, outlines, labels, and other visual elements. Each basemap style emphasizes a specific type of cartographic theme and data.Learn more is typically used in geocoding and routing applications. Update the basemap layer to use the style.

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

Expand
Use dark colors for code blocksCopy
    /* 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_URI", // The redirect URL registered in your OAuth credentials
    //   portal: "YOUR_PORTAL_URL" // Your portal URL
    // })

    // const accessToken = session.token;

    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      zoom: 12, // starting zoom

      center: [-79.3832, 43.6532] // Toronto

    });

    const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
      style: "arcgis/navigation",
      token: accessToken
    });
Expand

Add end point layers

To display circles for the start and end of the route, you will two circle layersA layer in Mapbox GL JS is a visual element that displays data from a source.Learn more. Each layer needs a GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more sourceA source in Mapbox GL JS is a file or service that supplies data for a layer displayed in a map.Learn more 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
      zoom: 12, // starting zoom

      center: [-79.3832, 43.6532] // Toronto

    });

    const basemapStyle = maplibreArcGIS.BasemapStyle.applyStyle(map, {
      style: "arcgis/navigation",
      token: accessToken
    });

    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 sourceA source in Mapbox GL JS is a file or service that supplies data for a layer displayed in a map.Learn more. The second click will update the end source. To set the GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more 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 GeoJSONGeoJSON is an open standard for representing geographic information in a JSON file. It is commonly used for sharing data between web services or manipulating vector data in the browser.Learn more LineString object. To display it, you define a GeoJSON sourceA source in Mapbox GL JS is a file or service that supplies data for a layer displayed in a map.Learn more and a line layerA layer in Mapbox GL JS is a visual element that displays data from a source.Learn more.

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 JSArcGIS REST JS is a collection of JavaScript modules that can access ArcGIS location services and ArcGIS Enterprise services.Learn more to call the solveRoute function to access the route serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more. 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 serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more. 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",
          findBestSequence: false,
          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",
          findBestSequence: false,
          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 serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more 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 location services in these tutorials:

Reverse geocode

Find the closest address to a clicked location on a map.

A map of Santa Monica, California, with multiple nearby place markers inside a circular search radius. A details panel displays full place information.

Find nearby places and details

Find places near a location and get detailed place information.

Map showing service area polygons representing travel coverage from Bangkok, Thailand.

Find service areas

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