Query Parameters

Parameter Description Usage
point Specifies the starting point from where the travel boundary is calculated.

Point format: longitude,latitude,srs

Example of single point format: '-45, 75, epsg:4326'

 Required
address Specifies the starting address from where the travel boundary is calculated.

Example of address: '2, Abc road, New Jersey'.

Note: Search can either be performed based on location coordinates mentioned in the 'point' parameter or based on address. If both 'point' and 'address' parameters are specified, search is performed based on location coordinates mentioned in point and the address is ignored.
 Required
costs Specifies the 'distance' in terms of cost units specified in costUnit parameter. This parameter returns a separate travel boundary for each cost specified. The maximum travel boundary in case of distance is 100 miles. Up to 3 cost values can be specified in comma separated format. Required
costUnit Specifies the metric type used to calculate the travel boundary.

Available Distance Units:

  • m (Meter)
  • km (Kilometer)
  • yd (Yard)
  • ft (Foot)
  • mi (Mile)

Default: 'm'

Optional
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
maxOffroadDistance The maximum distance to allow travel off the road network using the 'maxOffroadDistanceUnit'. Examples of off-network roads include driveways and access roads. For example, if you specify a maximum off road distance of 1 mile the travel boundary will extend no further than one mile from the network road. If you specify a value of 0 the travel boundary will not extend beyond the road itself.

Default: 1 mile

Optional
maxOffroadDistanceUnit The distance unit defining the 'maxOffroadDistance'. You must also define maxOffroadDistance if you define this parameter.

Available Distance Units:

  • m (Meter)
  • km (Kilometer)
  • yd (Yard)
  • ft (Foot)
  • mi (Mile)

Default: 'mi'

 Optional
destinationsSrs Specifies the desired coordinate system of the travel boundary.

Default: epsg:4326

 Optional
majorRoads Specifies whether to include all roads in the calculation or just major roads. If you choose to include only major roads, performance will improve but accuracy may decrease.

Possible values: 'true' or 'false'

Default: 'true'

Optional
returnHoles Specifies whether you want to return holes, which are areas within the larger boundary that cannot be reached within the desired time or distance, based on the road network.

Default: 'false'

 Optional
returnIslands Specifies whether you want to return islands, which are small areas outside the main boundary that can be reached within the desired time or distance.

Default: 'false'

 Optional
simplificationFactor Specifies the percentage of the original points that are returned. Upon this value the resulting complexity of geometries is based.

Simplification factor has a value greater than 0.0 and less than or equal to 1.0

Default value is: 0.5

 Optional
bandingStyle

Specifies the style of banding to be used in the result. Banding styles are the types of multiple distance bands that can be displayed based on multiple costs. Banding styles can be returned in the following formats:

Donut

Each boundary is determined by subtracting out the next smallest boundary. This is the default method.

Encompassing

Each boundary is determined independent of all others.		 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
defaultAmbientSpeed The speed to travel when going off a network road to find the travel boundary (for all road types). To control how off-network travel is used in the travel boundary calculation, you need to specify the speed of travel off the road network (the ambient speed). Ambient speed can affect the size and shape of the travel boundary polygon. In general, the faster the ambient speed, the larger the polygon. For example, if you were at a point with 5 minutes left, and if the ambient speed were 15 miles per hour, boundary points would be put at a distance of 1.25 miles. If the ambient speed were reduced to 10 miles per hour, boundary points would be put at a distance of 0.83 miles. Optional
ambientSpeedUnit The unit of measure to use to calculate the ambient speed. Available speed units are: MPH(miles per hour), KPH(kilometers per hour), MTPS(meters per second), MTPM(meters per minute) Optional