Query Parameters

Parameter Description Usage
startAddresses Start locations in text based addresses.

For Example: 2, Abc road, New Jersey | 1global view, ​troy, ny

Required
endAddresses End locations in text based addresses.

For Example: 5, Abc road, New Jersey | 1global view, ​troy, ny

Required
Note: startAddresses*endAddresses should not exceed 25. For example, you can enter 5 comma separated startAddresses values and 2 comma separated endAddresses values, which multiples to 5*2=10, which is less than 25, and an accepted value.

If you enter 6 comma separated startAddresses and 6 comma separated endAddresses, which equals 36, will not be accepted as it exceeds the limit of 25.
db Specifies the mode of commute.

Possible Values: 'driving' and 'walking'

Default: 'driving'

Optional
country 3 digit ISO code or country name.
Default: USA
Note: Providing value for this parameter is recommended if address is mentioned.
 Optional
destinationSrs Specifies the coordinate system used for the returned routes.

Default: epsg:4326

 Optional
optimizeBy Specifies the type of optimizing to use for the route.

Possible values: 'time' or 'distance'

Default: 'time'

 Optional
returnDistance Specifies whether to return the travel distance in the response or not.
Default: 'true'
Note: Both returnDistance and returnTime parameters cannot be 'false' in the same request.
 Optional
distanceUnit Specifies the unit to return distance. Available values are:
  • m (Meter)
  • km (Kilometer)
  • yd (Yard)
  • ft (Foot)
  • mi (Mile)

Default: 'm'

Optional
returnTime Specifies whether to return the travel time in the response or not.

Possible Values: 'true' and 'false'

Default: 'true'

Note: Both returnDistance and returnTime parameters cannot be 'false' in the same request.
 Optional
timeUnit Specifies the unit to return time. Available values are:
  • min (Minute)
  • msec (Millisecond)
  • s (Second)
  • h (Hour)

Default: 'min'

 Optional
majorRoads Specifies whether to include all roads in the calculation or just major roads. If 'true' then only the major roads are included that result in performance increase but reduced accuracy.

Possible values: 'true' or 'false'

Default: 'false'

Optional
returnOptimalRoutesOnly Specifies whether to return only the optimized route for each start point and end point combination. The optimized route is either the fastest route or the shortest distance, depending on the optimizeBy parameter.

Default: 'true'

 Optional
historicTrafficTimeBucket

Specifies whether the routing calculation uses the historic traffic speeds. These speeds are based on different time-of-day buckets. The data must have historic traffic speeds included in order to use this feature. The data for each country/region has the same bucket definitions, where the speeds for these bucket values may vary. The options are:

None

The default value. Historic traffic data is not used in the calculation. Instead an averaged speed value is used.

AMPeak

Calculate routes with the peak AM speeds. The AMPeak time bucket is from 07:00 to 10:00hr time of day.

PMPeak

Calculate routes with the peak PM speeds. The PMPeak time bucket is from 16:00 to 19:00hr time of day.

OffPeak

Calculate routes with the off peak (daytime) speeds. The OffPeak time bucket is from 10:00 to 16:00hr time of day.

Night

Calculate routes with the nighttime speeds. The Night time bucket is from 22:00 to 04:00hr time of day.
Note: This parameter is applicable for the following countries:
  • Brazil
  • Canada
  • USA
  • Mexico
  • Great Britain
  • Sweden
  • South Africa
 Optional
useCvr Enables or disables CVR capabilities. Allowed values are Y or N (case sensitive).

Default: 'N'

 Optional
looseningBarrierRestrictions

Specifies that barriers will be ignored when determining the route. These restrictions most often occur when a commercial vehicle is prohibited from traversing a segment due to local ordinance, or a commercial vehicle is allowed on the segment but only when it must (for example, last mile access, local delivery, and so on).

 Optional
vehicleType Choose either ALL or one of the following:
  • STRAIGHT
  • SEMI_TRAILOR
  • STANDARD_DOUBLE
  • INTERMEDIATE_DOUBLE
  • LONG_DOUBLE
  • TRIPLE
  • OTHER_LONG_COMBINATION_VEHICLE
 Optional
weight Specifies the maximum weight of a vehicle. Any vehicles over this value will be restricted when determining the route. Optional
weightUnit Specifies the unit to be used for specifying the maximum weight of the vehicle. The units of weights are:
  • kg – kilogram (default)
  • lb - pound
  • mt - metric tones
  • t - ton
 Optional
height Specifies the maximum height of a vehicle. Any vehicles over this value will be restricted when determining the route. Optional
heightUnit Specifies the unit to be used for specifying the maximum height of the vehicle. The units of height are:
  • ft - foot (default)
  • m - meter
  • yd - yard
  • km - kilometer
  • mi - mile
 Optional
length Specifies the maximum length of a vehicle. Any vehicles over this value will be restricted when determining the route. Optional
lengthUnit Specifies the unit to be used for specifying the maximum length of the vehicle. The units of length are:
  • ft - foot (default)
  • m - meter
  • yd - yard
  • km - kilometer
  • mi - mile
 Optional
width Specifies the maximum width of a vehicle. Any vehicles over this value will be restricted when determining the route. Optional
widthUnit Specifies the unit to be used for specifying the maximum width of the vehicle. The units of width are:
  • ft - foot (default)
  • m - meter
  • yd - yard
  • km - kilometer
  • mi - mile
 Optional