Routes
Copy link

Summary
Copy link

This tool calculates the fastest route, with turn-by-turn directions, from every departure location to every arrival location, using the /routes endpoint.

Parameters
Copy link

Description
Departure LocationsThe point layer routes start from
Departure Locations IDThe field identifying each departure location in the output
Travel ModeAny of the 13 transport modes the Custom tools offer
Departing / ArrivingWhether routes leave the Departure Locations at the chosen time, or reach the Arrival Locations by it
Time ZoneThe time zone the departure or arrival time is in
Departing / Arriving TimeThe departure or arrival time
Arrival LocationsThe point layer routes end at
Arrival Locations IDThe field identifying each arrival location in the output
Output StyleHow the routes are drawn and tabled (see below). Defaults to By journey.
Propertiestravel_time (seconds) and distance (metres) are always included. fares adds public transport fares as JSON text (UK only).
Fields To Keep [Departure Locations] / [Arrival Locations]Fields from either layer to copy onto the output
Output LayerWhere to save the output - must be in the project geodatabase

The optional Transportation options, Search range and Snapping are described on Common parameters. With a search range and Range Results above 1, each alternative route is a row of its own, numbered by an alternative field (0 = fastest).

Output style
Copy link

  • By journey - one line per route, each coloured separately
  • By travel time - one line per route, coloured by bands of total journey time
  • By transport type - one line per leg of each route, coloured by the transport used, with turn-by-turn directions in the attribute table

Output
Copy link

A line layer. Each row has location_id (the departure location), search_id (the arrival location), travel_time and distance. With By transport type, each row is one leg and also has its mode and directions.