Query Parameters

Parameter Description Usage
startAddress Specifies the starting point of the route.

For Example: 1global view, ​troy, ny

 Required
endAddress Specifies the ending point of the route.

For Example: 2, Abc road, New Jersey

 Required
db Specifies the mode of commute.

Possible Values: driving and walking.

Default: driving

 Optional
country 3 character ISO code or country name. When performing search based on 'address' parameter, it is recommended to specify country for precise results.

Default: USA

 Optional
intermediateAddresses Specifies the list of intermediate addresses. Up to 25 pipe separated text based addresses are supported.

Example: 5 Dakota Dr #300, New Hyde Park, NY 11042| 6 Dakota Dr #300, New Hyde Park, NY 11042| 15 Dakota Dr #300, New Hyde Park, NY 11042

 Optional
returnIntermediatePoints Whether to return the intermediate points with the route response Optional
directionsStyle Specifies whether route directions text is to be returned.

Possible values: 'None', 'Normal' and 'Terse'.

None: No directions returned. Default, if not specified.

Normal: Directions are returned in a full format.

Terse: Directions are returned in a short format.

Default: 'None'

 Optional
segmentGeometryStyle Specifies the geometry of every segment come back in the response.

Possible values: 'none', 'end', 'all'

Default: 'none'

Note: Only segment end points in end value and all shape points of segment if value specified is 'all'.
Optional
oip Specifies whether the waypoints need to be optimized or the default order must be kept while route calculation.

Possible values: 'true' or 'false'

Default: 'false'

 Optional
optimizeBy Specifies the type of optimizing to be used for the route.

Possible values: 'time' or 'distance'

Default: 'time'

 Optional
returnDistance Specifies whether or not the distance is to be sent back in response with routing information.

Possible values: 'true' or 'false'

Default: 'true'

 Optional
distanceUnit

Specifies unit to return distance. Available values are:

  • m (Meter)
  • km (Kilometer)
  • yd (Yard)
  • ft (Foot)
  • mi (Mile)
  • Default: 'm'
Optional
returnTime Specifies whether or not time is to be sent back in response with route direction text.

Possible values: 'true' or 'false'

Default: 'true'

 Optional
timeUnit

Specifies unit to return time. Available values are:

  • min (Minute)
  • msec (Millisecond)
  • s (Second)
  • h (Hour)

Default: 'min'

 Optional
language Specifies the travel directions in specified languages.

Default: English (en)

Available languages are:

  • ALBANIAN (sq)- Return directions in Albanian.
  • CHINESE (zh_CN)- Return directions in Chinese
  • TAIWANESE (zh_TW)- Return directions in Taiwanese
  • CROATIAN (hr)- Return directions in Croatian
  • CZECH (cs)- Return directions in Czech
  • DANISH (da)- Return directions in Danish
  • DUTCH (nl)- Return directions in Dutch
  • ENGLISH (en)- Return directions in English
  • ENGLISH_US (en-US)- Return directions in English_US
  • ESTONIAN (et)- Return directions in Estonian
  • FINNISH (fi)- Return directions in Finnish
  • FRENCH (fr)- Return directions in French
  • GERMAN (de)- Return directions in German
  • HUNGARIAN (hu)- Return directions in Humgarian
  • ITALIAN (it)- Return directions in Italian
  • JAPANESE (ja)- Return directions in Japanese
  • LATVIAN (lv)- Return directions in Latvian
  • LITHUANIAN (lt)- Return directions in Lithuanian
  • NORWEGIAN (no)- Return directions in Norwegian
  • PORTUGUESE (pt)- Return directions in Portuguese
  • RUSSIAN (ru)- Return directions in Russian
  • TURKISH (tr)- Return directions in Turkish
  • ROMANIAN (ro)- Return directions in Romanian
  • SLOVAK (sk)- Return directions in Slovak
  • SLOVENIAN (sl)- Return directions in Slovenian
  • SPANISH (es)- Return directions in Spanish
  • SWEDISH (sv)- Return directions in Swedish
Note: Is applicable when the directionStyle is set as short or full.

Optional
primaryNameOnly If 'true' then only the primary street name is returned otherwise all the names for a street are returned.

Possible values: 'true' or 'false'

Default: 'false'

Optional
majorRoads 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
destinationSrs Specifies the desired coordinate system of the returned routes.

Default: epsg:4326

 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
returnDirectionGeometry

Specifies whether to return a separate geometry associated with the route instruction in route response.

Default: 'false'

 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