Migration Guide

Where do I find the Orbis V3 end point

The Orbis Routing API V3 end point is:

post
URL request format
https://{baseURL}/maps/orbis/routing/routes/calculate?key={Your_API_Key}&apiVersion={apiVersion}&{param=value}

Changes from Genesis to Orbis V3 in the parameters or responses

  • The base path parameter routePlanningLocations has been removed.
    • Please use the routePlanningLocations POST data parameter instead. The locations are specified in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
      • As a consequence, only POST method is supported.
  • formatVersion has been removed from the response.
  • Either apiVersion query parameter or TomTom-Api-Version header needs to be present.
  • The query parameter routeType has been removed In Orbis. Please use the routeType POST data parameter instead. It has a new set of values in Orbis: fast, short, efficient, and thrilling.
    • Please use fast instead of fastest, short instead of shortest, and efficient instead of eco.
  • The POST data parameter routeType in the legs object has a new set of values in Orbis: fast, short, efficient, and thrilling.
    • Please use fast instead of fastest, short instead of shortest, and efficient instead of eco.
  • The query parameter traffic has a new set of values in Orbis: live and historical.
    • Please use live instead of true and historical instead of false.
  • The query parameter travelMode has been removed In Orbis. Please use the travelMode POST data parameter instead.
  • The POST data parameter parameter travelMode only supports car in Orbis.
  • The query parameter vehicleEngineType has been removed In Orbis. Please use the vehicleEngineType POST data parameter instead.
  • The query parameter arrivalSidePreference has been removed In Orbis. Please use the arrivalSidePreference POST data parameter instead.
  • The query parameter key has been replaced with the TomTom-Api-Key header.
  • simpleCategory has been replaced by iconCategory with new values: accident, brokenDownVehicle, dangerousConditions, flooding, fog, ice, jam, laneClosed, rain, roadClosed, roadWorks, wind, unknown
  • delayInSeconds has been replaced by delayDurationInSeconds
  • magnitudeOfDelay has been replaced by delayMagnitude with new values: unknown, minor, moderate, major, undefined
  • Response headers Pragma and Warning have been removed.
  • The query parameter alternativeType has been removed.
  • The query parameter minDeviationDistance has been removed.
  • The query parameter minDeviationTime has been removed.
  • The query parameter supportingPointIndexOfOrigin has been removed.
  • The query parameter reconstructionMode has been removed.
  • The query parameter constantSpeedConsumptionInLitersPerHundredkm has been removed.
    • As a consequence, the response field fuelConsumptionInLiters has been removed from the summary.
  • The query parameter currentFuelInLiters has been removed.
  • The query parameter auxiliaryPowerInLitersPerHour has been removed.
  • The query parameter fuelEnergyDensityInMJoulesPerLiter has been removed.
  • The query parameter accelerationEfficiency has been removed.
  • The query parameter decelerationEfficiency has been removed.
  • The query parameter uphillEfficiency has been removed.
  • The query parameter downhillEfficiency has been removed.
  • The query parameter constantSpeedConsumptionInkWhPerHundredkm has been removed.
    • As a consequence, the response field batteryConsumptionInkWh has been removed from the summary.
  • The query parameter currentChargeInkWh has been removed.
  • The query parameter maxChargeInkWh has been removed.
  • The query parameter auxiliaryPowerInkW has been removed.
  • The query parameter consumptionInkWhPerkmAltitudeGain has been removed.
  • The query parameter recuperationInkWhPerkmAltitudeLoss has been removed.
  • The POST data parameter encodedPolyline has been removed.
  • The POST data parameter encodedPolylinePrecision has been removed.
  • The POST data parameter pointWaypoints has been removed.
    • As a consequence, the POST data parameter pointWaypoint has been removed.
      • As a consequence, POST data parameters waypointSourceType and supportingPointIndex have been removed.
  • The POST data parameters encodedPolyline and encodedPolylinePrecision have been removed from the legs POST data parameter.
  • The response field planningReason has been removed from the summary.
  • The POST data parameter pauseTimeInSeconds has been renamed to pauseDurationInSeconds.
  • The response field userDefinedPauseTimeInSeconds has been removed from the summary.
  • The response field encodedPolyline has been removed from the legs.
  • The response field encodedPolylinePrecision has been removed from the legs.
  • The query parameter departAt has been removed.
    • Please use the departureDateTime POST data parameter instead.
  • The query parameter arriveAt has been removed.
    • Please use the arrivalDateTime POST data parameter instead.
  • The response field encodedPolyline has been removed. Now its value is represented in the new compressedPath’s data field.
  • The response field encodedPolylinePrecision has been removed. Now its value is represented in the new compressedPath’s precision field.
  • The response field compressedPath is new output field for encoded polyline route representation.
  • The response field points has been renamed to path and is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
  • The response field deviationPoint is now in GeoJSON format. For more details, refer to the RFC 7946 .
  • The POST data parameter entryPoints in routeStop now uses GeoJSON MultiPoint format instead of an array of objects with latitude and longitude. For more details about GeoJSON, refer to the RFC 7946 .
  • The response field countryCode has been renamed to countryCodeIso2. It follows ISO 3166-1 alpha-2 standard.
  • The response field travelTimeInSeconds in the route.summary and leg.summary has been renamed to travelDurationInSeconds.
  • The response field trafficDelayInSeconds in the route.summary and leg.summary has been renamed to trafficDelayDurationInSeconds.
  • The response field departureTime in the route.summary and leg.summary has been renamed to departureDateTime.
  • The response field arrivalTime in the route.summary and leg.summary has been renamed to arrivalDateTime.
  • The response field sections has changed from an array of section objects to a map of arrays. Each key in the map is a section type and each value is an array of section objects of that type. The sectionType field has been removed from individual section objects.
  • The response field startPointIndex in the section objects has been renamed to startPathIndex and the response field endPointIndex has been renamed to endPathIndex.
  • The speedlimit section object has new fields. The maxSpeedLimitInKilometersPerHour has been replaced with the speedRestrictions list of objects. Please refer to the API documentation for details about the speedRestrictions list of objects.

Changes from Genesis to Orbis V3 in the features

  • Only the calculateRoute service is available in Orbis.
  • The base path parameter contentType has been removed in Orbis.
    • The response content type can be specified with the Accept request header.
  • The base path parameter routePlanningLocations has been removed.
    • Please use the routePlanningLocations POST data parameter instead. The locations are specified in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
      • As a consequence, only POST method is supported.
  • Only JSON responses are supported in Orbis.
    • As a consequence, the statusCode field is not provided in the response in Orbis.
    • The query parameter callback has been removed in Orbis.
  • Guidance instructions are now controlled via a new guidance POST data parameter instead of the instructionsType query parameter.
    • Set guidance to instructions to enable guidance. Omit it or set to none to disable.
    • The Genesis coded/text/tagged distinction no longer exists. Human-readable instruction messages are included by default when guidance is enabled. To exclude them, use the Attributes-Exclude header with routes.instructions.message.
    • The tagged message format is no longer available.
    • The instructionPhonetics parameter has been moved from a query parameter to a mandatory POST data parameter with lowercase values (ipa instead of IPA, lhp instead of LHP). The none value has been removed — one of the supported values (ipa or lhp) must be provided when guidance is enabled.
    • The query parameter language has been removed in Orbis. Please use the Accept-Language request header instead.
    • The header Content-Language is now included in the response to indicate the language used when selecting language‑dependent data.
    • The query parameter instructionAnnouncementPoints has been removed in Orbis. Instruction announcement points (earlyWarningAnnouncement, mainAnnouncement, confirmationAnnouncement) are no longer supported.
    • The query parameter instructionRoadShieldReferences has been removed in Orbis. Road shield data is now included automatically in RoadInformation.roadShields when guidance is enabled.
      • As a consequence, the roadShieldAtlasReference field is not provided in the response in Orbis. The Genesis atlas-based model (where reference sprite keys were resolved against an external sprite sheet URL) has been replaced by self-contained RoadShield objects that embed the road number, country code, and phonetic information directly.
    • The response structure has been simplified: guidance instructions are returned directly in routes[].instructions[] instead of routes[].guidance.instructions[].
    • The instructionGroups array (firstInstructionIndex, lastInstructionIndex, groupLengthInMeters, groupMessage) has been removed.
    • Combined messages (combinedMessage and possibleCombineWithNext) have been removed.
    • The instruction object has been significantly restructured:
      • point (object with latitude/longitude) has been replaced by maneuverPoint (GeoJSON Point).
      • pointIndex has been removed. Replaced by the routePath array of RoutePathPoint objects with point, distanceFromRouteStartInMeters, and travelTimeFromRouteStartInSeconds.
      • travelTimeInSeconds has been removed. In V3, travel time per point is available via RoutePathPoint.travelTimeFromRouteStartInSeconds in the routePath array.
      • instructionType has been removed. The instruction type is inferred from the maneuver code.
      • junctionType (REGULAR, ROUNDABOUT, BIFURCATION) has been removed.
      • turnAngleInDecimalDegrees has been replaced by changeOfAngleInDegrees, with changes to both scope and semantics:
        • No longer present for fork maneuvers (keepLeft, keepRight, keepCenter), which correspond to the Genesis BIFURCATION junctionType.
        • Now also present for roundabout maneuvers (roundaboutStraight, roundaboutRight, etc.), which did not have this field in Genesis. Note that exitRoundabout is excluded and does not carry this field.
        • The semantics differ: Genesis indicated the direction of the instruction; Orbis V3 represents the total change of angle from entry to exit of the maneuver, within the range [-180, 180).
      • street has been removed. Street information is now in previousRoadInformation and nextRoadInformation as structured RoadInformation objects with properties, roadShields, roadNumbers, roadNames, and countryCodeIso2.
      • roadNumbers (array of strings) has been removed from the instruction root. Now available as RoadInformation.roadNumbers, an array of RoadIdentifier objects with phonetic information, source, and road attribute.
      • signpostText and exitNumber (string) have been removed. Replaced by the structured signpost object with exitName, exitNumber, and towardName (each as TextWithPhonetics).
      • countryCode (ISO 3166-1 alpha-3) has been removed from the instruction root. Country code is now in RoadInformation.countryCodeIso2 (ISO 3166-1 alpha-2).
      • stateCode (subdivision part only, e.g., AN) has been removed from the instruction root. Now RoadShield.countrySubdivisionCodeIso with full ISO 3166-2 code (e.g., ES-AN).
      • Phonetic fields (phoneticStreet, phoneticStreetLanguageCode, phoneticSignpostText, phoneticSignpostTextLanguageCode, phoneticRoadNumbers, phoneticRoadNumberLanguageCodes) have been removed. Phonetic information is now bundled with each name in the TextWithPhonetics pattern (text, phonetic, phoneticLanguageCode).
      • roadShieldReferences and signpostRoadShieldReferences arrays have been removed. Road shield data is now structured within RoadInformation.roadShields as RoadShield objects.
    • New fields in V3 with no Genesis equivalent:
      • routePath — array of RoutePathPoint objects defining the maneuver geometry.
      • maneuverView — schematic representation of the intersection (onRouteAngle, offRouteAngles).
      • previousRoadInformation / nextRoadInformation — structured RoadInformation objects.
      • signpost — structured object with exitName, exitNumber, and towardName (each as TextWithPhonetics).
      • intersectionName — name of the intersection at the maneuver (TextWithPhonetics).
      • isManeuverObligatory — marks a turn maneuver as obligatory.
      • roundaboutType — indicates roundabout type (regular or small).
      • tollgateName — name of the tollgate (TextWithPhonetics).
      • tollPaymentTypes — array of available payment options at a tollgate.
      • countryCrossingFromName / countryCrossingToName — country names for border crossings (TextWithPhonetics).
      • countryCrossingFromCodeIso2 / countryCrossingToCodeIso2 — country codes (ISO 3166-1 alpha-2) for border crossings.
      • landmark — notable feature near the maneuver (e.g., atTrafficLight, intoTunnel).
      • ambiguousExitOffsetFromManeuverInMeters — offset of an ambiguous exit before the maneuver.
      • sideRoads — list of roads connecting to the route before the maneuver.
      • mergePointRouteOffsetInMeters — route offset where the route merges onto a new motorway.
    • All enum values have changed from UPPER_SNAKE_CASE to camelCase (e.g., KEEP_RIGHTkeepRight, LEFTleft).
    • Maneuver code changes from Genesis to V3:
      • Direct casing changes: DEPARTdepart, ARRIVEarrive, ARRIVE_LEFTarriveLeft, ARRIVE_RIGHTarriveRight, KEEP_RIGHTkeepRight, KEEP_LEFTkeepLeft, TURN_RIGHTturnRight, TURN_LEFTturnLeft, MAKE_UTURNmakeUTurn, ROUNDABOUT_RIGHTroundaboutRight, ROUNDABOUT_LEFTroundaboutLeft, ROUNDABOUT_BACKroundaboutBack, WAYPOINT_REACHEDwaypointReached, WAYPOINT_LEFTwaypointLeft, WAYPOINT_RIGHTwaypointRight.
      • Renamed (not just casing): STRAIGHTcontinueStraight, BEAR_RIGHTturnSlightRight, BEAR_LEFTturnSlightLeft, SHARP_RIGHTturnSharpRight, SHARP_LEFTturnSharpLeft, ROUNDABOUT_CROSSroundaboutStraight, MOTORWAY_EXIT_LEFTexitMotorwayLeft, MOTORWAY_EXIT_RIGHTexitMotorwayRight, TAKE_FERRYtakeShipFerry.
      • Removed (no V3 equivalent): ENTER_MOTORWAY, ENTER_FREEWAY, ENTER_HIGHWAY, TAKE_EXIT, TRY_MAKE_UTURN, FOLLOW, SWITCH_PARALLEL_ROAD, SWITCH_MAIN_ROAD, ENTRANCE_RAMP.
      • New in V3: waypointAhead, arriveAhead, keepCenter, roundaboutSharpRight, roundaboutSlightRight, roundaboutSharpLeft, roundaboutSlightLeft, exitRoundabout, exitMotorwayMiddle, switchMotorwayLeft, switchMotorwayRight, switchMotorwayMiddle, enterCarpoolLaneLeft, enterCarpoolLaneRight, exitCarpoolLaneLeft, exitCarpoolLaneRight, mergeLeftLane, mergeRightLane, leaveShipFerry, takeCarTrain, leaveCarTrain, crossBorder, passTollgate.
  • lanes sections are not supported and are not provided in the response in Orbis.
  • roadShields sections are not supported and are not provided in the response in Orbis.
    • As a consequence, the roadShieldAtlasReference field is not provided in the response in Orbis.
  • tollRoads and tollVignette sections are not supported and are not provided in the response in Orbis.
    • As a consequence, sections with sectionType TOLL provide sections which include either a usage-based toll or toll vignette, in the response in Orbis.
  • circle waypoints are not supported in Orbis.
  • The query parameter coordinatePrecision has been removed in Orbis.
    • Responses contain full precision coordinates in Orbis.
  • The query parameter computeBestOrder has been removed in Orbis.
    • As a consequence, the optimizedWaypoints field is not provided in the response in Orbis.
  • The query parameter computeTravelTimeFor has been removed in Orbis.
    • As a consequence, the noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds, and liveTrafficIncidentsTravelTimeInSeconds fields are not provided in the response in Orbis.
  • The query parameter report has been removed in Orbis.
    • As a consequence, the effectiveSettings field is not provided in the response in Orbis.
  • The query parameter prefer has been removed in Orbis.
  • handsFreeDriving sections are not supported and are not provided in the response in Orbis.
  • The query parameter handsFreeDrivingCapability has been removed in Orbis.
  • The query parameter hilliness has been removed in Orbis.
  • The query parameter windingness has been removed in Orbis.
  • The query parameter vehicleAxleWeight has been removed in Orbis.
  • The query parameter vehicleNumberOfAxles has been removed in Orbis.
  • The query parameter vehicleLength has been removed in Orbis.
  • The query parameter vehicleWidth has been removed in Orbis.
  • The query parameter vehicleHeight has been removed in Orbis.
  • The query parameter vehicleCommercial has been removed in Orbis.
  • The query parameter vehicleLoadType has been removed in Orbis.
  • The query parameter vehicleAdrTunnelRestrictionCode has been removed in Orbis.
  • The query parameter chargeMarginsInkWh has been removed in Orbis.
    • As a consequence, the reachableRouteOffsets field is not provided in the response in Orbis.
  • The POST data parameter avoidVignette has been removed in Orbis.
  • The POST data parameter allowVignette has been removed in Orbis.
  • The POST data parameter reassessmentParameterSets has been removed in Orbis.
    • As a consequence, the routeReassessments field is not provided in the response in Orbis.
  • The POST data parameter hilliness in the legs object has been removed in Orbis.
  • The POST data parameter windingness in the legs object has been removed in Orbis.
  • The POST data parameter supportingPoints (both in legs and for the whole route) has been replaced with the path parameter and is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
  • The query parameter vehicleHeading has been replaced with the POST data parameter vehicleHeadingInDegrees in Orbis.
  • The query parameter vehicleHasElectricTollCollectionTransponder has been replaced with the POST data parameter vehicleHasElectronicTollCollectionTransponder in Orbis.
  • The query parameter vehicleMaxSpeed has been replaced with the POST data parameter vehicleMaxSpeedInKilometersPerHour in Orbis.
  • The query parameter vehicleWeight has been replaced with the post data parameter vehicleWeightInKilograms in Orbis.
  • The query parameter maxAlternatives has been removed in Orbis. Please use the maxPathAlternativeRoutes POST data parameter instead.
  • The query parameter avoid has been removed in Orbis. Please use the avoids POST data parameter instead. The avoids parameter now takes an array of avoid enum values.
    • The lowEmissionZones avoid value is not supported in Orbis V3.
  • the POST data parameter rectangles inside avoidAreas now uses GeoJSON Feature format instead of specifying southWestCorner and northEastCorner. For more details about GeoJSON, refer to the RFC 7946 .
  • The /routing/calculateRoute endpoint has been renamed to /routing/routes/calculate.
  • The Attributes request header is now required. It specifies which response fields to include using dot-notation. Some response fields are marked as EXPLICIT and must be explicitly listed in this header. See the API documentation for the Response field selection section.
  • The Attributes-Exclude request header is now available (optional). It specifies which response fields to exclude using dot-notation.
  • The query parameter routeRepresentation has been removed.
    • Please select the desired route representation using the Attributes and Attributes-Exclude request headers.
  • The query parameter sectionType has been removed.
    • Please select the sections as needed using the Attributes and Attributes-Exclude request headers.
  • The query parameter extendedRouteRepresentation has been removed.
  • The response progress object has been replaced with progressPoints.
    • Please select the progressPoints fields as needed using the Attributes and Attributes-Exclude request headers.
    • The fields in progressPoints differ from the previous progress object:
      • pointIndex has been renamed to pathIndex.
      • travelTimeInSeconds has been renamed to travelDurationInSeconds.
      • batteryConsumptionInkWh has been removed.

Changes from Orbis V2 to Orbis V3

  • The base path parameter contentType has been removed.
    • The response content type can be specified with the Accept request header.
  • The base path parameter routePlanningLocations has been removed.
    • Please use the routePlanningLocations POST data parameter instead. The locations are specified in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
      • As a consequence, only POST method is supported.
  • formatVersion has been removed from the response.
  • The query parameter key has been replaced with the TomTom-Api-Key header.
  • simpleCategory has been replaced by iconCategory with new values: accident, brokenDownVehicle, dangerousConditions, flooding, fog, ice, jam, laneClosed, rain, roadClosed, roadWorks, wind, unknown
  • delayInSeconds has been replaced by delayDurationInSeconds
  • magnitudeOfDelay has been replaced by delayMagnitude with new values: unknown, minor, moderate, major, undefined
  • Response headers Pragma and Warning have been removed.
  • The POST data parameter supportingPoints (both in legs and for the whole route) has been replaced with the path parameter and is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
  • The POST data parameter entryPoints in routeStop now uses GeoJSON MultiPoint format instead of an array of objects with latitude and longitude. For more details about GeoJSON, refer to the RFC 7946 .
  • The query parameter alternativeType has been removed.
  • The query parameter minDeviationDistance has been removed.
  • The query parameter minDeviationTime has been removed.
  • The query parameter supportingPointIndexOfOrigin has been removed.
  • The query parameter reconstructionMode has been removed.
  • The query parameter constantSpeedConsumptionInLitersPerHundredkm has been removed.
    • As a consequence, the response field fuelConsumptionInLiters has been removed from the summary.
  • The query parameter currentFuelInLiters has been removed.
  • The query parameter auxiliaryPowerInLitersPerHour has been removed.
  • The query parameter fuelEnergyDensityInMJoulesPerLiter has been removed.
  • The query parameter accelerationEfficiency has been removed.
  • The query parameter decelerationEfficiency has been removed.
  • The query parameter uphillEfficiency has been removed.
  • The query parameter downhillEfficiency has been removed.
  • The query parameter constantSpeedConsumptionInkWhPerHundredkm has been removed.
    • As a consequence, the response field batteryConsumptionInkWh has been removed from the summary.
  • The query parameter currentChargeInkWh has been removed.
  • The query parameter maxChargeInkWh has been removed.
  • The query parameter auxiliaryPowerInkW has been removed.
  • The query parameter consumptionInkWhPerkmAltitudeGain has been removed.
  • The query parameter recuperationInkWhPerkmAltitudeLoss has been removed.
  • The POST data parameter encodedPolyline has been removed.
  • The POST data parameter encodedPolylinePrecision has been removed.
  • The POST data parameter pointWaypoints has been removed.
    • As a consequence, POST data parameter pointWaypoint has been removed.
      • As a consequence, POST data parameters waypointSourceType and supportingPointIndex have been removed.
  • The POST data parameters encodedPolyline and encodedPolylinePrecision have been removed from the legs POST data parameter.
  • The response field planningReason has been removed from the summary.
  • The POST data parameter pauseTimeInSeconds has been renamed to pauseDurationInSeconds.
  • The response field userDefinedPauseTimeInSeconds has been removed from the summary.
  • The response field encodedPolyline has been removed from the legs.
  • The response field encodedPolylinePrecision has been removed from the legs.
  • The query parameter departAt has been removed.
    • Please use the departureDateTime POST data parameter instead.
  • The query parameter arriveAt has been removed.
    • Please use the arrivalDateTime POST data parameter instead.
  • The response field encodedPolyline has been removed. Now its value is represented in the new compressedPath’s data field.
  • The response field encodedPolylinePrecision has been removed. Now its value is represented in the new compressedPath’s precision field.
  • The response field compressedPath is new output field for encoded polyline route representation.
  • The response field points has been renamed to path and is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .
  • The response field deviationPoint is now in GeoJSON format. For more details, refer to the RFC 7946 .
  • The response field countryCode has been renamed to countryCodeIso2. It follows ISO 3166-1 alpha-2 standard.
  • The response field travelTimeInSeconds in the route.summary and leg.summary has been renamed to travelDurationInSeconds.
  • The response field trafficDelayInSeconds in the route.summary and leg.summary has been renamed to trafficDelayDurationInSeconds.
  • The response field departureTime in the route.summary and leg.summary has been renamed to departureDateTime.
  • The response field arrivalTime in the route.summary and leg.summary has been renamed to arrivalDateTime.
  • The query parameter heading has been replaced with the POST data parameter vehicleHeadingInDegrees.
  • The query parameter vehicleHasElectricTollCollectionTransponder has been replaced with the POST data parameter vehicleHasElectronicTollCollectionTransponder.
  • The query parameter vehicleMaxSpeed has been replaced with the POST data parameter vehicleMaxSpeedInKilometersPerHour.
  • The query parameter vehicleWeight has been replaced with the post data parameter vehicleWeightInKilograms.
  • The query parameter maxAlternatives has been removed. Please use the maxPathAlternativeRoutes POST data parameter instead.
  • The query parameter avoid has been removed. Please use the avoids POST data parameter instead. The avoids parameter now takes an array of avoid enum values.
    • The lowEmissionZones avoid value is not supported in Orbis V3.
  • The POST data parameter entryPoints in routeStop now uses GeoJSON MultiPoint format instead of an array of objects with latitude and longitude. For more details about GeoJSON, refer to the RFC 7946 .
  • The query parameter routeType has been removed. Please use the routeType POST data parameter instead.
  • the POST data parameter rectangles inside avoidAreas now uses GeoJSON Feature format instead of specifying southWestCorner and northEastCorner. For more details about GeoJSON, refer to the RFC 7946 .
  • The response field sections has changed from an array of section objects to a map of arrays. Each key in the map is a section type and each value is an array of section objects of that type. The sectionType field has been removed from individual section objects.
  • The response field startPointIndex in the section objects has been renamed to startPathIndex and the response field endPointIndex has been renamed to endPathIndex.
  • The speedlimit section object has new fields. The maxSpeedLimitInKilometersPerHour has been replaced with the speedRestrictions list of objects. Please refer to the API documentation for details about the speedRestrictions list of objects.
  • The query parameter travelMode has been removed. Please use the travelMode POST data parameter instead.
  • The query parameter vehicleEngineType has been removed. Please use the vehicleEngineType POST data parameter instead.
  • The query parameter arrivalSidePreference has been removed. Please use the arrivalSidePreference POST data parameter instead.
  • The /routing/calculateRoute endpoint has been renamed to /routing/routes/calculate.
  • The Attributes request header is now required. It specifies which response fields to include using dot-notation. Some response fields are marked as EXPLICIT and must be explicitly listed in this header. See the API documentation for the Response field selection section.
  • The Attributes-Exclude request header is now available (optional). It specifies which response fields to exclude using dot-notation.
  • The query parameter routeRepresentation has been removed.
    • Please select the desired route representation using the Attributes and Attributes-Exclude request headers.
  • The query parameter sectionType has been removed.
    • Please select the sections as needed using the Attributes and Attributes-Exclude request headers.
  • The query parameter extendedRouteRepresentation has been removed.
  • The response progress object has been replaced with progressPoints.
    • Please select the progressPoints fields as needed using the Attributes and Attributes-Exclude request headers.
    • The fields in progressPoints differ from the previous progress object:
      • pointIndex has been renamed to pathIndex.
      • travelTimeInSeconds has been renamed to travelDurationInSeconds.
      • batteryConsumptionInkWh has been removed.