Route Comparison

Our /route and /derivedRoute resources include a number of functions that allow you to generate commercial vehicle routes (Route Path), determine the route that was taken using latitude/longitude pings (Derived Route), and consider possible routes by looking at the time and distance between a series of locations (Route Matrix and Drive Time Polygon).

Below are descriptions of the parameters shared across these functions.

Data Element Description Data Type Value/Example
stops The coordinates that make up the stops of the route. Each stop is specified as a comma-separated pair of floating point numbers, representing longitude and latitude respectively. There must be at least two pairs of coordinates. List of comma-separated long/lat pairs, separated by semi-colons -76.123456,42.123456;-76.123126,42.123126
stopsAsViaPoints The via points you create can be designated as stops or waypoints. The “waypoint” designation means that these locations were added only to guide the route along desired roads. Waypoints are treated like stops on the map (routes travel through the centroid of a waypoint town or city), but they don’t appear in the driving instructions in the Driver’s Directions Report and are marked as a “Via” in the Detailed route Report. Waypoints appear on the stop list as circles with a gray border.

When provided true, all stops between the first and last are treated as via points.

boolean
True
False (Default)
vehType The vehicle type
Enum
0 - Truck (Default)
1 - LightTruck
2 - Auto
routeType The desired routing algorithm
Enum
0 - Practical (Default)
1 - Shortest
2 - Fastest
hwyOnly Indicates whether to use highways only
boolean
True
False (Default)
avoidFavors Indicates whether to use Route Modifiers (roads to avoid or favor) when generating a routing
boolean
True
False (Default)
overrideClass A comma separated list of class overrides.
Note if if vehLength is larger than 48' (e.g. 48.1') and/or vehWidth is larger than 96" (e.g. 96.1"), then overrideClass is set to 3(National Network + FiftyThreeFoot) without an option to turn it off;
if vehLength is smaller than 48'and vehWidth is smaller than 96", then overrideClass is set to 0(None) by default. However, you can still provide overrideClass param to override it.
Enum
0 - None (Default)
1 - FiftyThreeFoot
2 - NationalNetwork
3 - NationalNetwork and FiftyThreeFoot
distUnits Distance Units
Enum
0 - Miles (Default)
1 - Km
avoidTolls Indicates whether or not to avoid tolls. This parameter has been deprecated. Use tollRoads instead.
boolean
True
False (Default)
tollRoads Indicates whether or not to avoid toll roads when generating a route. If this parameter is specified, the value in avoidTolls will be ignored. If this parameter is null, the value in avoidTolls will be used.
int
1 - Always Avoid
2 - Avoid if Possible
3 - Use
Default is null.
openBorders Sets whether or not international borders are open to travel. Set to false to minimize the number of international border crossings, unless they are necessary to reach all of the stops on a route. For example, if all your stops are in the “lower 48” United States, the resulting route will stay in the United States even if the most practical or shortest route would normally involve some Canadian mileage.
The true option ignores international boundaries in generating the best route.
boolean
True (Default)
False
avoidCountry A comma-separated list of ISO2 codes for countries that should be avoided when generating a route. Default is an empty list. This parameter is for regions outside of North America.
string
BE, LU
avoidState A comma-separated list of ISO2 codes for states that should be avoided when generating a route. Default is an empty list. This parameter is for North America only.
string
DE, RI
favorCountry A comma-separated list of ISO2 codes for countries that should be favored when generating a route. Default is an empty list. This parameter is for regions outside of North America.
string
DE, FR
favorState A comma-separated list of ISO2 codes for states that should be favored when generating a route. Default is an empty list. This parameter is for North America only.
string
PA, CT
overrideRestrict Indicates whether or not to override truck restrictions pertaining to specific sizes and weights when generating a route.
boolean
True
False (Default)
hazMat Indicates the hazardous material type. See details in Glossary.
Enum
0 - None (Default)
1 - General
2 - Caustic
3 - Explosives
4 - Flammable
5 - Inhalants
6 - Radioactive
routeOpt Indicates the method by which to optimize route stops.
Enum
0 - None (Default)
1 - ThruAll
2 - DestinationFixed
lang Language
Enum
0 - ENUS (U.S. English)
1 - ENGB (Great Britain English)
2 - DE (German)
3 - FR (French)
4 - ES (Spanish)
5 - IT (Italian)
hubRouting Indicates whether or not to enable hub routing. Hub Routing generates routes from a single starting place (origin) to multiple destinations.
boolean
True
False (Default)
vehDimUnits Vehicle dimension units
Enum
0 - English (Default)
1 - Metric
vehHeight The height of the truck in feet and inches or meters depending on vehDimUnits.
Valid range is between 5' and 15' for English Unit, or between 1.524 and 5 meters for Metric Unit.
string
13'6" or 4.1148
vehLength The length of the truck in feet and inches or meters depending on vehDimUnits.
Valid range is between 8' and 70' for English Unit, or between 2.4384 and 28 meters for Metric Unit.
string
53' or 16.1544
vehWidth The width of the truck in inches or meters depending on vehDimUnits.
Valid range is between 60" and 102" for English Unit, or between 1.524 and 3 meters for Metric Unit.
string
96" or 2.44
vehWeight The weight of the truck in pounds or kilograms depending on vehDimUnits.
Valid range is between 1500 and 156470 lbs for English Unit, or between 680.39 and 60000 kgs for Metric Unit.
string
axles The number of axles on the truck
Int
Acceptable values are 2 through 14 and the default value is 5
truckConfig The truck style.
Enum
0 - None (Default)
1 - TwentyEightDoubleTrailer
2 - FortyStraightTruck
3 - FortyEightSemiTrailer
4 - FiftyThreeSemiTrailer
5 - FullSizeVan
6 - TwentySixStraightTruck
7 - ConventionalSchoolBus (NA only)
8 - SmallSchoolBus (NA only)
LCV Indicates whether the truck is a multi-trailer or longer combination vehicle.
boolean
True
False (Default)
estimatedTimeOpts Estimated time options affects routing only when roads have time based restrictions.
Format:
Depart(Arrive)|[DayOfWeek]|[TimeOfDay]
or Depart(Arrive)|[SpecificDateTime]|[TimeZone]
Supported time zones can be found here
string
Examples:
Depart|Monday|18:30
Arrive|2014-03-04T08:15:30|Local
(Default is none)
hosEnabled Indicates whether or not to enable Hour of Service option.
boolean
True
False (Default)
hosRemDriveTimeUntilBreak The available driving hours at origin before the driver needs to take a rest break.
double
The format is in seconds.
hosRemDriveTime The available driving hours at origin until the end of work day.
double
The format is in seconds.
hosRemOnDutyTime The available On-Duty hours available at origin until the end of work day.
double
The format is in seconds.
hosRuleType The hours of service rule to use.
Enum
Valid values are
0 - USFed607LH
1 - USFed708LH for US Federal Long Haul rules.
hosRemCycleDutyTime The available Cycle time duty hours at origin until Cycle reset.
double
The format is in seconds.
sideOfStreetAdherence How strict to be in order to avoid the destination being on the opposite side of the street.
Enum
0 - Off (Default)
1- Minimal
2 - Moderate
3 - Average
4 - Strict
5 - Adhere
6 - StronglyAdhere
useCrossStreetTurnAvoidance When set to true, it reduces the chances the route generated includes turns that go across the street in front of oncoming traffic. These turns will still be included if there is no reasonable alternative.(For auto and van Vehicle Routing Profiles only)
boolean
True
False (Default).
governorSpeedLimit Maximum average road speed to use in route calculations that overrides all other road speeds when they are above this value. Default is disabled and valid value is between 1 and 100 mph.
double
The format is in mph or kph based on distance units.
region The data region in which stop coordinates lie.
Enum
0 - Unknown
1 - AF
2 - AS
3 - EU
4 - NA (Default)
5 - OC
6 - SA
7 - ME
dataset The Regional dataset.
Enum
PCM_EU
PCM_OC
PCM_SA
PCM_ME
PCM_AS
PCM_AF
PCM_WW (Worldwide)
PCM_GT (GeoTrack)
Current (Default)
PCM23-PCM33 (routePath only)
classOvrdtype A comma-separated list of road class overrides.
Enum
0 - None (Default)
1 - NationalNetwork
2 - FiftyThreeFoot
vehProfile Indicates the vehicle routing profile which is a preset collection of dimensions and routing options.
Enum
0 - None (Default,which is equivalent to the 48-foot semitrailer profile)
1 - TwentyEightDoubleTrailer
2 - FortyStraightTruck
3 - FortyEightSemiTrailer
4 - FiftyThreeSemiTrailer
5 - FullSizeVan
6 - TwentySixStraightTruck
7 - ConventionalSchoolBus (NA only)
8 - SmallSchoolBus (NA only)
afSetIDs Apply the avoid/favor sets to the route. Int Array Default is none, i.e. empty list.
afSetNames Apply the avoid/favor sets to the route. String Array Default is none, i.e. empty list.
reduceResponsePoints Indicates whether to reduce the number of response points.
boolean
True
False (Default)
elevLimit Indicates the elevation limit when generating a route. Elevation unit is specified in feet or meters.
uint
ferryDiscourage Indicates whether or not to discourage the use of ferries when creating the route.
boolean
True
False (Default)
useSites Indicates whether or not the route stops are on sites and to accordingly consider site gates.
boolean
True
False (Default)
includePLIDs Whether to include PLID metadata for the generated route. A PLID is a road link's primary ID coded in the map data.
boolean
True
False (Default)
Last updated March 16, 2021.