Find a route and directions | ArcGIS REST JS

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

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a new app

Open a terminal and create a new folder for your project.
Use dark colors for code blocksCopy
```
1
2
mkdir find-a-route-and-directions
cd find-a-route-and-directions
```
Initialize a new Node.js project. This creates a package.json file.
Use dark colors for code blocksCopy
```
1
npm init
```
Install the required packages.
Use dark colors for code blocksCopy
```
1
npm install @esri/arcgis-rest-request @esri/arcgis-rest-routing --save
```
Tip
Set "type": "module" in your package.json so you can import the packages later in your JavaScript file. To see other installation options, such as using a CDN or import map, go to Install and set up.
Create a new JavaScript file named index.js.
Use dark colors for code blocksCopy
```
1
touch index.js
```

Get an access token

Create a new API key credential with the correct privileges to get an access token.

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges:
  - Location services > Routing
Copy the API key access token to your clipboard when prompted.

Make a request

Open your index.js file and import the packages.

index.js
Use dark colors for code blocks

import { ApiKeyManager } from "@esri/arcgis-rest-request";
import { solveRoute } from "@esri/arcgis-rest-routing";

Paste in your access token.

index.js
Use dark colors for code blocks

import { ApiKeyManager } from "@esri/arcgis-rest-request";
import { solveRoute } from "@esri/arcgis-rest-routing";

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

Make a request to the ArcGIS Geocoding service and print the results.

index.js
Use dark colors for code blocks

import { ApiKeyManager } from "@esri/arcgis-rest-request";
import { solveRoute } from "@esri/arcgis-rest-routing";

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

solveRoute({
  stops: [
    [-117.195677, 34.056383],
    [-117.918976, 33.812092]
  ],
  authentication
}).then((response) => {
  console.log(JSON.stringify(response, null, 2));
});

Save the file, then run it from the terminal.
Use dark colors for code blocksCopy
```
1
node index.js
```

You should now see the results printed in your console.

Use dark colors for code blocksCopy
{
  "checksum": "rI7WAA6YygA.",
  "requestID": "c9d60ae1-8cdd-495f-a5e4-f2e239448050",
  "routes": {
    "fieldAliases": {
      "ObjectID": "ObjectID",
      "Name": "Name",
      "FirstStopID": "FirstStopID",
      "LastStopID": "LastStopID",
      "StopCount": "StopCount",
      "Total_TravelTime": "Total_TravelTime",
      "Total_Kilometers": "Total_Kilometers",
      "Total_Miles": "Total_Miles",
      "Shape_Length": "Shape_Length"
    },
Expand

What's next?

Learn how to use additional location services in these tutorials:

Search for an address

Search for a specific address or place and retrieve its coordinates.

Find place addresses

Find coffee shops, gas stations, restaurants and other nearby places.

Query a feature layer (spatial)

Access and query a hosted feature layer with a geometry and spatial operator.