Mode of transport to be used for the calculation of the isolines.

Note: bicycle, bus and privateBus modes are currently provided as Beta, with limited functionality. Please refer to the Developer Guide for more details here.

Center of the isoline request. The Isoline(s) will cover the region which can be reached from this point within given range. It cannot be used in combination with destination or arrivalTime parameter.

Format

Format: Place[WaypointOptions]

• Place: {lat},{lng}[PlaceOptions]
• PlaceOptions: ;option1=value1;option2=value2...
• WaypointOptions: !option1=value1!option2=value2...

A waypoint consists of:

• Exactly one place
• Optional settings for the place
• Optional settings for the waypoint itself

Supported place options

• course: int, degrees clock-wise from the north. Indicates the desired direction from the place. For example, 90 indicating east. Often combined with radius and/or minCourseDistance

• sideOfStreetHint: {lat},{lng}. Indicates the side of the street that should be used. For example, if the location is to the left of the street, the router will prefer using that side in case the street has dividers. For example, 52.511496,13.304140;sideOfStreetHint=52.512149,13.304076 indicates that the north side of the street should be preferred. This option is required, if matchSideOfStreet is set to always. Option cannot be combined with radius, radiusPenalty or snapRadius.

• displayLocation: {lat},{lng}. Indicates the physical location of the POI. It is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments.

• matchSideOfStreet: enum [always, onlyIfDivided]. Specifies how the location set by sideOfStreetHint should be handled. Requires sideOfStreetHint to be specified as well.

  • always : Always prefer the given side of street.
  • onlyIfDivided: Only prefer using the side of street set by sideOfStreetHint in case the street has dividers. This is the default behavior.

• nameHint: string. Causes the router to look for the place with the most similar name. The typical examples include: North being used to differentiate between interstates I66 North and I66 South, Downtown Avenue being used to correctly select a residental street.

  Empty string values are ignored.

• radius: int, meters. Sets the radius within which all locations are considered equally eligible for selection as waypoints. Typical use cases include scenarios with imprecise coordinates or user input provided on low resolution map displays. The value is capped at 200 meters. Setting a higher value doesn't return an error. Can't be used with snapRadius.

• radiusPenalty: int, percentage 0-1000. Used in conjunction of radius parameter. Router will match the waypoint, within the specified radius and penalize candidates according to air distance to the waypoint. Penalty is proportional to given percentage, 100 being just cost of air distance and 200 double. Currently works only for pedestrian/bicycle routes. Alpha: This parameter is in development. It may not be stable and is subject to change.

• snapRadius: int, meters. Sets the radius within which waypoints are matched to the most "significant" place. Candidates for matching are sorted in the order of significance which is based on the visibility on a zoomed-out map. A highway is considered more significant than a national road, while a national road is more significant than a city road. Typical use case - selecting waypoints on a zoomed-out view of a map on a drag-and-drop interface, where only significant roads are visible. A big enough radius allows to match waypoints to such roads. Can't be used with radius or radiusPenalty parameters.

• minCourseDistance: int, meters. Instructs the routing service to try to find a route that avoids actions for the indicated distance. For example, if the origin is determined by a moving vehicle, the user might not have time to react to early actions. Values greater than 2000 meters will be capped at 2000 meters.

• segmentIdHint: string. Causes the router to try and match to the specified segment. Waypoint coordinates need to be on the segment, otherwise waypoint will be matched ignoring the segment hint This parameter can be used when the waypoint is too close to more than one segment to force matching to a specific one.

• onRoadThreshold: int, meters. allows specifying a distance within which the waypoint could be considered as being on a highway/bridge/tunnel/sliproad. Within this threshold, the attributes of the segments do not impact the matching. Outside the threshold only segments which aren't one of highway/bridge/tunnel/sliproad can be matched.

Notes

• Non-structural reserved characters in options' values need to be properly percent-encoded. Please refer to the developers' guide for more details.

Center of the isoline request. The Isoline(s) will cover the region within the specified range that can reach this point. It cannot be used in combination with origin or departureTime parameter.

For a description of the format and options for this parameter, please refer to the description of the origin parameter.

Specifies which optimization is applied during the calculation.

• fast: Route calculation from start to destination optimized by travel time. In many cases, the route returned by fast mode may not be the route with the fastest possible travel time. For example, the routing service may favor a route that remains on a highway, even if a faster travel time can be achieved by taking a detour or shortcut through an inconvenient side road.
• short: Route calculation from start to destination disregarding any speed information. In this mode, the distance of the route is minimized, while keeping the route sensible. This includes, for example, penalizing turns. Because of that, the resulting route will not necessarily be the one with minimal distance.

Notes:

• The following Transport modes only support fast routingMode
  • bicycle
  • bus
  • pedestrian
  • privateBus
  • scooter
  • taxi

Specifies how isoline calculation is optimized.

• quality: calculation of isoline focuses on quality, that is, the graph used for isoline calculation has higher granularity generating an isoline that is more precise.
• performance: calculation of isoline is performance-centric, quality of isoline is reduced to provide better performance.
• balanced: calculation of isoline takes a balanced approach averaging between quality and performance.

Specifies which of the EV consumption models is being used. See the ev parameter for details on the models.

• empirical
• physical

Alpha: Physical consumption model is in development. It may not be stable and is subject to change.

Specify new base speed for segment by value. Affects route selection and the ETA. Cannot increase base speed on segment.

A list of up to six billing tags, separated by the + sign.

This parameter provides a way to track your platform usage. For details, refer to the Cost Management Developer Guide section on Billing Tags

User-provided token that can be used to trace a request or a group of requests sent to the service.