{"openapi":"3.0.2","info":{"title":"HERE Route Matching V8 API","description":"Match the GPS trace to get the most probable driven path. This path can be further enriched with HERE core map attributes and additional information which can be used for driver risk analysis.","termsOfService":"https://developer.here.com/terms-conditions","license":{"name":"HERE Documentation License","url":"https://legal.here.com/en-gb/terms/documentation-license"},"version":"8.3.3"},"externalDocs":{"description":"The Developer guide and Release notes are available here.","url":"https://www.here.com/docs/category/route-matching-api"},"servers":[{"url":"https://routematching.hereapi.com","description":"Generated server url"}],"security":[{"apiKey":[]},{"bearerTokenAuth":[]}],"tags":[{"name":"Route Matching V8","description":"Match GPS traces onto the most probably driven path"}],"paths":{"/v8/match/routelinks":{"get":{"tags":["Route Matching V8"],"summary":"Match GPS traces to get the most probably driven path. Use &routeMatch=1 for default route matching behavior. Compatible with version 2 route matching.","description":"\n\nNote: We recommend using POST requests for large payloads, as GET requests may be constrained by request-line length limits imposed by load balancers.","operationId":"HERE Route Matching V8 API matchRouteV8compatibilityToV2GET","parameters":[{"name":"routeMatch","in":"query","description":"For route matching, use parameter value `1`. Used to select the operational mode of the Route Matching algorithm. Supported values are 0|1|2|4.\n* 0 - Default value - DEPRECATED. Computes a legal route that goes through all waypoints. This mode is deprecated. Use HERE Routing API v8 instead.\n* 1 - Route Matching mode - treats waypoints (or a trace file from the POST request body) as a GPS trace and returns the most probable matched route along this trace.\n* 2 - ETA Tracking mode - Available only for POST requests. Computes the route based on the specified waypoints. Additionally, it uses the GPS trace from the request body to detect rest stops or breaks taken by the driver as well as reached or skipped waypoints. To get maneuvers for a matched route, set `&legAttributes=mn`.\n* 4 - eHorizon mode - In development - not feature-complete. Returns an additional eHorizon, which is a configurable path ahead of the calculated or matched route.\n* 5 - Combined mode - This mode combines `routeMatch=1` and `routeMatch=4`.\n\n**Note:** Using ETA Tracking mode triggers an additional transaction - keep in mind for cost tracking.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Vehicle type.\n* Supported vehicle types : bdouble, bicycle, bus, car, carHOV, emergency, motorcycle, pedestrian, roadtrain, taxi, truck.","required":true,"schema":{"type":"string"}},{"name":"legal","in":"query","description":"Used in `routeMatch=1|2`. Enforces a legal route with respect to the following route condition types (comma separated list): access, gate, oneway, thrutraf, turn.\n* access: use links only allowed for the vehicle type (incl. truck measures).\n* gate: don't traverse gates.\n* oneway: don't drive links into forbidden direction.\n* throughTraffic: don't enter/leave 'no through traffic' zones.\n* turn: don't turn/u-turn illegally.\n* Passing all of them yields a legal path as from a route matching perspective.\n* Default value: avoid illegal maneuvers, but use them if the trace obviously contains them. If matched, returns respective warnings.","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","description":"Used in `routeMatch=0|1|2`. If set to `true`, assumes the driver has keys/permissions to traverse gates.\n* Supported values are: `true`, `false' or `airlineDistanceInMeters,entryPenaltyInSec`.\n* `traverseGates=airlineDistanceInMeters,entryPenaltyInSec` - Only gates within the given airline distance in meters around a waypoint can be traversed. A one-time entry penalty of specified number of seconds is added to the internal cost calculation of the route. \n* `entryPenaltyInSec` must be between 0 and 2 hours (7200 sec).\n* `entryPenaltyInSec` can be used to tune the algorithm to either choose passing through the gate or use potential alternative road ways to reach destinations behind a gate.\n* Default value: `false` - don't traverse any gates unless vehicle type is `emergency`. `* Gate traversal violation in routeMatch=1 mode are reported as warning.","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","description":"Used in `routeMatch=0|2`. Allows to control oneway traffic violation behavior. Default - obey all oneways.\n* This parameter is supported only for vehicle types `bicycle` or `emergency`.\n* Format - `penalty:penaltyFactor`,. `penalty:0.5` - allows oneway traffic violation if the time benefit is more than 0.5 second/meter.\n* For bicycle recommended `penaltyFactor` value 0.125, for emergency 0.5.\n* Oneway traffic violations in `routeMatch=1` mode are reported as warnings.","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius (in meters) that will be applied to each waypoint.\n* If specified, overrides the `transitRadius` value set for waypoints and the default maximum adaptive search radius.\n* For routing (`routeMatch=0`), the default value is: 1600m, max limit is 5000m.\n* In `routeMatch=1` mode this parameter can be used to configure the radius that is used to match trace points to the road network, with the default value of 300m and the max limit of 10000m.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma-separated list of Map Attributes layer names used to get additional attributes along the route.\n* Only link-based attribute layers (roughly those ending in _FC1, _FC2, etc. and _FCn) are supported.\n* Specify layer with `_FCn` (like `SPEED_LIMITS_FCn`), to get content from respective functional class layer corresponding to the link.\n* After each layer name, comma separated list of individual layer attributes can be listed within brackets. Use an asterisk (*) to get all layer attributes.\n* Example: `&attributes=LINK_ATTRIBUTE_FCn(*),ROAD_GEOM_FCn(TUNNEL),SPEED_LIMITS_FCn(FROM_REF_SPEED_LIMIT,TO_REF_SPEED_LIMIT)`.\n* A maximum of 32 layers can be requested at once.","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","description":"Vehicle type for toll calculation.\n* Supported values: 1 - Motorcycle, 2 - Auto, 3 - Truck, 4 - Motor home, 5 - Minibus, 6 - Bus, 7 - Motorcycle Sidecar(EU), 8 - Tricycle(EU), 9 - Delivery Truck(EU+India), 10 - Snowmobile(US), 11 - Pick-up (US+India), 12 - Tractor (US+India), 13 = Taxi, 14 - HCM/EME (Heavy Construction Machinery/Earth Moving Equipment - India)\n* Use if applicable toll should also be calculated for the route in routeMatch=0|2 mode.\n* Or use if applicable toll should be calculated for the matched route in routeMatch=1 mode.","required":false,"schema":{"type":"string"}},{"name":"rollups","in":"query","description":"Used in `routeMatch=0|1|2`. Comma separated list of rollups (groupings, aggregation levels) for the toll cost response. Currently supported values are:\n* `none` - toll cost details per link,\n* `total` - overall total toll cost only,\n* `tollsys` - toll cost summary per toll system,\n* `country` - summary per country,\n* `country;tollsys` - summary per country and toll system.\n* Example: `&rollups=none,country;tollsys,country` - returns the individual link level cost details and two different summaries.","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","description":"Used in routeMatch=0|1|2. Comma separated list of owned passes for toll cost calculation.\n* Allows traversal of 'transponder-only' toll booths, allows cost free traversal of certain toll sections and allows using cheaper prices for transponder/pass owners.\n* Supported values: `Senior_Pass`, `transponder` (meaning the vehicle has all transponders), `allPasses` (has all required passes), `Annual` (meaning the vehicle has all annual passes), `Nr_of_Days` (has all passes valid for number of days), `Nr_of_Months` (has all passes valid for number of months), `AutoPass`, `SunPass`, `E-Z Pass` (last 2 are examples for real toll transponders).\n* Can also list toll system ids or toll booth condition ids.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Three letter ISO currency symbol. Required if toll cost must be added up across different currencies and/or be added to driver/vehicle/fuel cost in different currencies.","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Specifies the time of departure for routeMatch=0|2.\n* Format: `now` or `yyyy-MM-dd'T'HH:mm:ss` or `yyyy-MM-dd'T'HH:mm:ssX`.\n* Example: `&departure=now` or `&departure=2024-10-27T11:52:50`\n* If no timezone is specified, then the local timezone at the route start link is used.\n* In routeMatch=2, the departure time for the route part is replaced by the last available GPS time from the trace.\n* If no departure parameter is set, all time dependent access restrictions are ignored.","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Only applicable when routeMatch=0. Format like parameter `departure`.\n* If an arrival time is specified, the estimated departure time of a journey is returned in the response.\n* Does not work if a departure time is specified in addition.\n* Note that toll cost is not considered when arrival time is specified.","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","description":"Used in routeMatch=0|2. Set to `true` or `false`, to enable/disable usage of traffic incidents for route estimation for complete length of the route. Default is `false` - traffic incidents are disabled.\n\n**Note:** Usage of traffic incidents will impact the routing response time, so use only if necessary.","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","description":"Used in routeMatch=0|1|2. Maximum speed allowed for the whole route.\n* Supported units are kmh (kilometres per hour), mph (miles per hour) and mps (metres per second).\n* If no unit is provided, kmh will be used as default unit.\n* Examples: `&maxSpeed=90` or `&maxSpeed=90kmh` or `&maxSpeed=55.92mph` or `&maxSpeed=25mps` .","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Only for routeMatch=0. Maximum number of alternative route options to return. Can return less or no alternatives. Only returns route alternatives that significantly differ from the best route but are not much more costly.","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","description":"Only for routeMatch=1|2. Route matching aligns the driving time to the GPS timestamps in trace (if available). Supported values: 0|1. This feature is enabled by default (1), set the value 0 to disable it.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Used in routeMatch=0|2. Comma-separated list of speeds in km/h driven per functional road class (1-5 + Virtual Connections VC) and speed category (1-8), for example, FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8.\n* Functional classes are semicolon-separated.\n* Can contain empty entries when there is no change to default ones used in the service, for example, 80,76,,,,,,;,,,54,46,,,;....\n* Overrides router's default driven speed values.\n* Predefined profiles can be activated using these values: `car`, `lightTruck`, `mediumTruck`,`heavyTruck`, `limitedWeight`, `learnIdSpeed`. \n* Example: `&speedFcCat=80,76,68,,,,,;,,,,,,,;,,,,,,,;,,,,,,,;,,,,,,,;,,,,,,,` - change the speed on FC1 roads for speed category 1 to 3 .","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","description":"Used in routeMatch=0|2. Map match tolerance (in meter) that will be applied to each way point. Routing can reach the waypoint on all links that are in the specified radius vicinity around the waypoint. Default 3.0m.","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","description":"Used in routeMatch=1|2. Option to specify that trace points without a provided speed value are ignored for matching. Default = consider all points. 1 = ignore trace points that have zero speed (only in traces that provide speed but not time).","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","description":"Used in routeMatch=1|2. For enabling calculation of spatial distance between tracepoints. Supported values: 0|1|2.\n* 0 - Default value, feature is disabled.\n* 1 - return spatial distance between matched trace points.\n* 2 - return spatial distance between original trace points","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"Trailer type in a vehicle + trailer combination. Supported values: 0 - None (Default), 1 - Caravan, 2 - Trailer, 3 - RVTrailer, 4 - BoatTrailer. Applicable for toll cost calculation and recreational vehicle restrictions.","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of vehicle axles excluding trailer axles. Applicable for toll cost calculation and country wide truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. Applicable for toll cost calculation and for country wide truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"Type of hybrid vehicle. Supported values: 1 - fuel+electric, 0 - otherwise (Default). Applicable for toll cost calculation.","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"Emission type category of the vehicle. supported values: 1 - EURO I, 2 - EURO II, 3 - EURO III, 4 - EURO IV, 5 - EURO V, 6 - EURO VI, 7 - EURO EEV, 8 - Electric Vehicles, 9 - EURO II with PRC (deprecated), 10 - EURO III with PRC (deprecated), 11 - EURO VII.\n* Applicable for toll cost calculation and environmental zone restrictions.\n* When emissionType is not specified it defaults to 5.","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. Supported values: 1 - Emission class 1, 2 - Emission class 2, 3 - Emission class 3, 4 - Emission class 4, 5 - Emission class 5.\n* Applicable for toll cost calculation only. When co2EmissionClass is not specified then it defaults to 1.\n* Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `350cm` or `3.5m` or `138in`. For toll cost calculation only, not considered for route path creation (use height parameter).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: `7.5t` or `7500kg` or `16500lbs`. See also limitedWeight. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Used in routeMatch=0|1|2. Legal maximum weight limit of vehicle incl. payload and trailers. Also including their payload as a total. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: `7.5t` or `7500kg` or `16500lbs`. Applicable for truck restrictions and requests for APPLICABLE_SPEED_LIMIT only.","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"Vehicle is signposted to to carry disabled people. Accepted values are: 1 - vehicle equipped to carry disabled people, 0 - otherwise (default). Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers in vehicle. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Total number of tires from vehicle, including tires on the base vehicle and any attached trailers. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"Vehicle use has commercial purpose. Accepted values are: 1 - vehicle registered for commercial use, 0 - no commercial use (Default: not specified). Applicable for toll cost calculation, environmental zone regulations and delivery-only zones.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"Height of the vehicle above its first axle. Example: `350cm` or `3.5m` or `138in`. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Supported values: Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric, LPG - Liquefied Petroleum Gas,  LNG - Liquefied Natural Gas).\nApplicable for environmental zone restrictions, toll cost calculation and consumption based routing for Electric vehicles.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported values: drive, single, tandem, triple, quad, quint. Example: `&weightPerAxleGroup=drive:12;single:11;tandem:18` .","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: `7.5t` or `7500kg` or `16500lbs`. See also parameter `limitedWeight`. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers or semi-trailers. For toll cost and truck restrictions.\n* Supported values: 0 - no trailer (default), 1 - one or more trailers, 2 - two or more trailers, 3 - three or more trailers, 4 - one or more semi-trailers.\n* `&trailersCount=4` is not supported for Waypoint Sequencing.","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers. Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `350cm` or `3.5m` or `138in`. Applicable for truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan including their payload.\n* Accepted value units are t (tons), kg (kilograms) or lbs (pounds).\n* Example: `7.5t` or `7500kg` or `16500lbs`.\n* Applicable for truck restrictions, speed profile selection, toll cost calculation and environmental zone restrictions. See also parameter `vehicleWeight`.\n* Note that country wide weight restrictions depend on the length, width, number of axles and trailers as well, so it might be necessary to specify these parameters as well.","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from supported values: `explosive`, `gas`, `flammable`, `combustible`, `organic`, `poison`, `radioActive`, `corrosive`, `poisonousInhalation`, `harmfulToWater`, `other`, `allhazardousGoods`, `explosiveFlammable`.\n* Applicable for toll cost calculation and truck restrictions.\n* For toll cost only values `explosive` and `other` are supported.\n* For Waypoints Sequence values `allhazardousGoods` and `explosiveFlammable` are not supported.","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers).\n* Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `1250cm` or `12.5m` or `492in`.\n* Applicable for toll cost calculation and truck restrictions.\n* Note that country wide length restrictions depend on the limitedWeight, width, number of axles and trailers as well, so it might be necessary to specify these parameters  as well.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload.\n* Accepted value units are t (tons), kg (kilograms) or lbs (pounds).\n* Example: `7.5t` or `7500kg` or `16500lbs`.\n* For Waypoints Sequence only supported unit is kg, without explicitly specifying unit.\n* Applicable for toll cost calculation and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle and trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `350cm` or `3.5m` or `138in`. Applicable for truck restrictions. Note that country wide width restrictions depend on the limitedWeight, length, number of axles and trailers as well, so it might be necessary to specify these parameters as well.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. Supported values: `B`, `C`, `D` or `E`.\n* `A` tunnels have no restrictions.\n* `E` tunnels have most restrictions.\n* Example: If `&tunnelCategory=C` is specified, then route will use `A` and `B` tunnels but not `C`, `D` or `E`.","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","description":"Used in routeMatch=0|2, to enable driver rest time calculations based on legal drive/rest intervals.\n* In `routeMatch=1` mode the response returns warnings if rest times were not detected.\n* The rest times can be specified by using the parameter _&restTimes=_ followed by one, four, five, six or ten comma separated values (no spaces).\n* Specify `&restTimes=local` (one value) to obey the legal driver rest times of the respective country where route is being traversed.\n* Example with four values: EU regulations requires that after 4.5h a 45min break and after 9h a 11h rest must be taken. This can be specified as `&restTimes=16200,2700,32400,39600` .\n* Alternatively, detailed rest time can be specified using upto ten proprietary comma separated values: _driveShortSec, timeShortSec, restShortSec, driveLongSec, timeLongSec, restLongSec, driveTimeSinceLastShortRestSec, elapsedTimeSinceLastShortRestSec, driveTimeSinceLastLongRestSec, elapsedTimeSinceLastLongRestSec_ .\n* For more detailed information and usage of this parameter, check the developer guide concepts page titled **Legal driver rest times**.'\n* In addition to normal rest time values, one can specify `;earlierRestTimeFactor:0.0`, to take rest times much earlier to reduce travel time (arriving with less legal driving time left), default = 0.75.","required":false,"schema":{"type":"string"}},{"name":"driver_cost","in":"query","description":"Used in routeMatch=0|2. Driver cost per hour in target currency. In routeMatch=0 mode, routes can be optimized based on cost by combining the driver, vehicle, and ferry costs with possible toll costs. This optimized cost is returned in the summary. Default: no driver cost given - no cost per hour optimization.","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","description":"Used in routeMatch=0|2. Cost per hour in target currency while driver is taking a legal rest time. Can be between 0 and driver_cost value. Can be used to optimize returned routes in mode routeMatch=0|2 based on cost.","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","description":"Used in routeMatch=0|2. Vehicle cost per kilometer in target currency. In routeMatch=0 mode, routes can be optimized based on cost by combining the driver, vehicle, and ferry costs with possible toll costs. This optimized cost is returned in the summary. Default: no vehicle cost given - no cost per kilometer optimization.","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","description":"Used in routeMatch=0|2. Vehicle cost per kilometer on ferry in target currency. Default = vehicle_cost. In routeMatch=0 mode, routes can be optimized based on cost by combining the driver, vehicle, and ferry costs with possible toll costs. This optimized cost is returned in the summary.","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","description":"Used in routeMatch=0|2. The cost of a consumption unit in targetCurrency. Default is 1.","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","description":"Used in routeMatch=1|2. Parameter to enable the advanced driving analytics / driving reports feature, added to the route match response (routeMatch=1).\n* Set to 1 to enable it, disabled by default.\n* For more information on this parameter and usage, check the developer guide concepts page titled **Advanced driving analytics**.\n\n**Note:** Using this feature will incur an additional transaction.","required":false,"schema":{"type":"string"}},{"name":"ehorizonLimits","in":"query","description":"Used in routeMatch=4 or routeMatch=5. Comma separated list of limitations for extending the electronic horizon path.\n* Format: `limitType:value`\n* Currently supported type is only `length` with value in meter. Example: `length:1000` .\n* For more information on this parameter and usage, check the developer guide concepts page titled **Driver alerts and Electronic Horizon**.\n\n**Note:**This feature is in development and not complete.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","description":"Used in mode routeMatch=0|2. Restrictions around waypoints can be ignored by setting value as: `radius[;drivePenaltyFactor[;type[;entryPenalty]]]`.\n* For detailed information on this parameter and its usage, please see developer guide concepts page titled **Find a path despite access restrictions**.\n* Example: `&ignoreWaypointVehicleRestriction=5000;1;all;1800` - ignore restrictions within 5 km around waypoints, with an entry penalty of 30 minutes and almost twice the driving time.\n* In mode `routeMatch=1`, a warning is returned if restriction violations are detected.","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","description":"Used in mode routeMatch=0|2. By default all admin wide truck restrictions are obeyed by the algorithm. If value is set to `ignore`, it will ignore them. Admin wide truck restriction violations in mode `routeMatch=1` are reported as warning.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Used in routeMatch=0|1|2. Route path/sections that should be avoided. Comma separated list of link ids or lat,lon[;heading] coordinates to be avoided.\n* Positive ids are avoided when driving from reference node  (start of link), negative ids are avoided when driving towards reference node  (end of link). Use '*' prefix to avoid both directions.\n* For coordinates, direction of blocking depends on the heading. If no heading given both directions will be avoided.\n* Optionally an entry penalty (applied once while entering the sequence of link(s)) and drive penalty (applied to every link) can be specified individually for each link to be avoided.\n* Format: `linkId[;penalty:entryPenaltySec[:drivePenaltyFactor]]` or `lat,lon[;heading[;penalty:entryPenaltySec[:drivePenaltyFactor]]]`.\n* `entryPenaltySec` should be between -120 and 600 (-ve penalty implies prefer).\n* `drivePenaltyFactor` should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer).\n* Example: `1308094486;penalty:60:1.5,-1308094485;penalty:2:2.5` or `50.1294,8.57124;185;penalty:60:1.5,50.12937,8.56944;177;penalty:60:1.5`.","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"Used in routeMatch=0|1|2. List of areas (rectangles or polygons) to be avoided.\n* Areas are separated by `!` sign.\n* Rectangles can be specified with two diagonal coordinates separated by semicolon. Format: `latitudeNorth,longitudeWest;latitudeSouth,longitudeEast`.\n* Polygons are specified with consecutive vertex coordinates separated by semicolon. Format: `latitude1,longitude1;laitudet2,longitude2;latitude3,longitude3;...` ","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","description":"Used in routeMatch=0|2. Option to use private streets for routing. Supported values: 0|1|-1.\n* Default is '0' - access is allowed if there is a waypoint in a street that is set for private use only.\n* Set it to '1' - always allow access to private streets.\n* Set it to '-1' - always forbid access to private streets.","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","description":"Only for routeMatch=0. Penalties in seconds to avoid unnecessary waiting time on border crossings.\n* Countries should be specified according to three character ISO 3166 standard.\n* A comma should be used to separate list of multiple avoidChangeCountry on the route.\n* Format: Country code1-Country code2:Penalty in seconds[,Country code1-Country code2:Penalty in seconds]\n* Example: `&avoidCountryChange=DEU-CHE:1200,HRV-SVN:280` - to avoid country change from Germany - Switzerland and from Croatia - Slovenia.","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","description":"Only for routeMatch=0. Preferred routes for a specific vehicle type are taken by default. To turn if off set ignorePreferredRoutes to true.","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","description":"For avoiding difficult turns on the route path.\n* Comma separated list of elements like `left[;minAngleDegree;penaltySec]` or `right[;minAngleDegree;penaltySec]` or `uTurn[;penaltySec]` .\n* If a left or right turn is sharper than the specified angle (between 0 - 180°), then the given time penalty is applied. Example: `&avoidTurns=right;120;200` .\n* If not explicitly specified in parameter, default `minAngleDegree` is set 80° and default `penaltySec` is set to 600 seconds. Example: `&avoidTurns=right` or `&avoidTurns=uTurn` .\n* For avoiding 180° turns to reverse the direction of travel (u-turns) set `uTurn` with penalty between 10 seconds and 600 seconds.  Example: `&avoidTurns=uTurn;300` .\n* Setting the value to `uTurnAtWaypoint` avoids u-turn on the link directly where the waypoint was reached.","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","description":"Used in routeMatch=0|2. Comma separated list of road features to be avoided.\n* Format: featureType[;entryPenalty;drivePenalty].\n* `entryPenalty` in seconds is applied once when the feature is avoided.\n* `drivePenalty` in seconds is applied for each km driven in avoided area.\n* `entryPenalty` and `drivePenalty` are optional. If not specified, default penalty values apply.\n* Currently supported feature type is only: `unpaved` with default `entryPenalty` of 1200 seconds (20 minutes) and `drivePenalty` of 120 seconds (2 minutes per km driven).\n* Example: `unpaved[;300;50]` - Avoids unpaved roads with 300 seconds penalty to enter and 50 seconds/km drive penalty.","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","description":"Only for routeMatch=0. Make use of truck verified roads for truck routing. Supported values: 0|1|-1.\n* Default is `0` - access is allowed, but truck verified routes are not preferred or avoided.\n* Set to `1` - prefer transport verified roads.\n* Set to `-1` - avoid transport verified roads.","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","description":"To choose the maneuver instruction text representation format in response. Supported formats are: `text` or `html`.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the maneuver instructions in the response.\n* Currently supported values:  `de-de`, `en-us`, `it-it`, `fr-fr`, `es-es`, `pt-pt`, `pl-pl`, `zh-cn`, `zh-tw`, `zh-hk` and `ja-jp`.\n* If not specified, `en-us` is used.","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","description":"Used in routeMatch=0|2. Defines which information is included in the response route part of the calculated route.\n* Defaults to mode (mo), waypoints (wp), summary (sm), flags (fl).\n* Also supported: speedProfile (sp), shape (sh), summaryByCountry (sc), boundingBox (bb), none.\n* All supported route attributes can also be excluded in the response by putting a hyphen in the front. e.g. `-wp` .","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Used in routeMatch=0|1|2, this parameter determines the information included in the response as part of the calculated route..\n* The default value is warnings (wn). Other supported options include language (lg) and none.\n* Any supported response attribute can be excluded by adding a hyphen (-) before it, e.g., `-wn`.","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the meta part of the calculated route.\n* Defaults to none. Also supported: version (ver).\n* Supported meta attributes can be excluded in the response by putting a hyphen in the front. e.g. `-ver`","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the response as part of the data representation of the route maneuvers.\n* Defaults to position (po), length (le), travelTime (tt).\n* Also supported: direction (di), action (ac), indices (ix), lanes (ln), roadName(rn), nextRoadName (nr), beforeAfter (ba) and none.\n* All supported maneuver attributes can be excluded in the response by putting a hyphen in the front. e.g. `-le`","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the response as part of the route legs.\n* Defaults to links (li), maneuvers (mn), length (le), travelTime (tt), baseTime (bt), trafficTime (tm).\n* Also supported: shape (sh), boundingBox (bb), turnbyturnmaneuvers (mm), none.\n* All supported leg attributes can be excluded in the response by putting a hyphen in the front. e.g. `-mn`.\n* Also in routeMatch=1|2 modes `legAttributes=mn` is supported.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the response for each link in a leg.\n* Defaults to shape (sh), length (le), remainTime (rt), remainDistance (rd), functionalClass (fc), warnings (wn), confidence (cd), segmentRef (sr).\n* Also supported: cost (co), maneuver (ma), timezone (tz), none.\n* All supported link attributes can be excluded in the response by putting a hyphen in the front. e.g. `-rt`","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","description":"Used in `routeMatch=0|1|2`. The penalty factor can be set from 0 to 100. The higher the value, the more effort is used internally to match waypoints in the given driving direction. Default = 1.","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","description":"Only for routeMatch=0, not supported for route matching. Specify if the route may not enter a specific zone type.\n* Currently supported values: `environmental`,`vignette` and `congestionPricing`.\n* If omitted or empty, zone restrictions are not taken into account.","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","description":"Used for `routeMatch=0|1|2`. Specify the licenseplate of the vehicle, which can influence the permission to drive in certain zones, mostly environmental zones. Environmental zone violations in `routeMatch=1` mode are reported as warning.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Used for `routeMatch=0|1|2`. Comma separated overlay map name(s). Used to reference towards private or adapted HERE road network attributions.\nIf an overlay is specified, the road network is used and included in the route calculation.\nIf multiple overlays are specified, they are treated as parent-child relationship. For example the parent overlay could contain the road geometry of a yard, then two different child overlays can be used to block certain road stretches dependent on the vehicle attribution.\nOverlay names are case insensitive. Must start with OVERLAY and contain only characters A-Z and numbers 0-9.\n\n**Note:** The `overlays` parameter is deprecated.","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","description":"Used for routeMatch=0|1|2. Comma separated list of key value pairs of custom restriction limits.\n* These custom restriction limits must be first uploaded into a custom road overlay.\n* The key and value of individual custom restriction limit must be numeric and must be separated by colon.\n* Example: `&customRestrLimit=0:10,1:20,2:50` .","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","description":"Comma separated list of Customer (BYOD) layer names, to get link attributes along the route. Custom layers can be uploaded in the Custom Location Service (also known as CLE) in self-hosting. Format follows the `attribute` parameter. No `FCn` notation supported.","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","description":"For mode routeMatch=0|2. Semicolon separated list of speed/ascent/descent/builtupFactor/auxilliaryConsumption fuel consumption parameters.\n* `Speed` is a list of $/km for different speeds.\n* `ascent` and `descent` are additional $/km per altitude climbed or descended.\n* `builtupFactor` is an optional heuristic consumption multiplier for urban area, default value is 1.55.\n* `auxilliaryConsumption` is the additional consumption (per hour) for running auxilliary units (climate control, infotainment, lights, etc.).\n* Cost unit is not $ but one specified in parameter 'currency'.\n* Example: `speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108;ascent,0.4;descent,0.1;builtupFactor,1.4`. This means at 70 kph the car consumes 6.6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area.\n* Alternatively, user can specify one of the default consumption profile using following supported values: 3.5t, 7.5t, 18t, 40t or weightDependent.\n* If specified as `weightDependent`, consumption profile will be decided based on vehicle weight in parameter `limitedWeight`. So, this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Custom timeout of a request. Processing of the request must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"waypointN","in":"query","description":"Only for modes routeMatch=0|2. Generic waypoint parameter to indicate the format. For routeMatch=1 trace to be matched should be added as POST body.\n* Waypoints should start with 'waypoint0' and increase in sequence (waypoint1, waypoint2..) to waypointN.\n* A route must consist of at least 2 waypoints (start and destination).\n* The maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time.\n* Format: latitude,longitude;transitRadius;label;heading[;optional specifications]\n* Set a transit radius to only influence the route to go via a certain city (Example: `&waypoint1=50.12,8.65;10000)`.\n* Set a heading (degree clockwise from North) to improve map matching (Example: `&waypoint0=latitude,longitude;;;140`).\n* To define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: `&waypoint1=stopOver,300!50.12,8.65`).\n* The optional specifications: altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\n* To define a radius around the waypoint where vehicle restrictions should be ignored use optional specification `;ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]`. Example: `&waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800` .\n* This is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied.","required":true,"schema":{"type":"string"}},{"name":"apikey","in":"query","description":"API key used to authenticate API requests.","required":true,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}},"post":{"tags":["Route Matching V8"],"summary":"Match GPS traces to get the most probable driven path. Must use `&routeMatch=1` for default route matching behavior. Compatible with version 2 route matching.","operationId":"HERE Route Matching V8 API matchRouteV8compatibilityToV2POST","parameters":[{"name":"routeMatch","in":"query","description":"For route matching, use parameter value `1`. Used to select the operational mode of the Route Matching algorithm. Supported values are 0|1|2|4.\n* 0 - Default value - DEPRECATED. Computes a legal route that goes through all waypoints. This mode is deprecated. Use HERE Routing API v8 instead.\n* 1 - Route Matching mode - treats waypoints (or a trace file from the POST request body) as a GPS trace and returns the most probable matched route along this trace.\n* 2 - ETA Tracking mode - Available only for POST requests. Computes the route based on the specified waypoints. Additionally, it uses the GPS trace from the request body to detect rest stops or breaks taken by the driver as well as reached or skipped waypoints. To get maneuvers for a matched route, set `&legAttributes=mn`.\n* 4 - eHorizon mode - In development - not feature-complete. Returns an additional eHorizon, which is a configurable path ahead of the calculated or matched route.\n* 5 - Combined mode - This mode combines `routeMatch=1` and `routeMatch=4`.\n\n**Note:** Using ETA Tracking mode triggers an additional transaction - keep in mind for cost tracking.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Vehicle type.\n* Supported vehicle types : bdouble, bicycle, bus, car, carHOV, emergency, motorcycle, pedestrian, roadtrain, taxi, truck.","required":true,"schema":{"type":"string"}},{"name":"legal","in":"query","description":"Used in `routeMatch=1|2`. Enforces a legal route with respect to the following route condition types (comma separated list): access, gate, oneway, thrutraf, turn.\n* access: use links only allowed for the vehicle type (incl. truck measures).\n* gate: don't traverse gates.\n* oneway: don't drive links into forbidden direction.\n* throughTraffic: don't enter/leave 'no through traffic' zones.\n* turn: don't turn/u-turn illegally.\n* Passing all of them yields a legal path as from a route matching perspective.\n* Default value: avoid illegal maneuvers, but use them if the trace obviously contains them. If matched, returns respective warnings.","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","description":"Used in `routeMatch=0|1|2`. If set to `true`, assumes the driver has keys/permissions to traverse gates.\n* Supported values are: `true`, `false' or `airlineDistanceInMeters,entryPenaltyInSec`.\n* `traverseGates=airlineDistanceInMeters,entryPenaltyInSec` - Only gates within the given airline distance in meters around a waypoint can be traversed. A one-time entry penalty of specified number of seconds is added to the internal cost calculation of the route. \n* `entryPenaltyInSec` must be between 0 and 2 hours (7200 sec).\n* `entryPenaltyInSec` can be used to tune the algorithm to either choose passing through the gate or use potential alternative road ways to reach destinations behind a gate.\n* Default value: `false` - don't traverse any gates unless vehicle type is `emergency`. `* Gate traversal violation in routeMatch=1 mode are reported as warning.","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","description":"Used in `routeMatch=0|2`. Allows to control oneway traffic violation behavior. Default - obey all oneways.\n* This parameter is supported only for vehicle types `bicycle` or `emergency`.\n* Format - `penalty:penaltyFactor`,. `penalty:0.5` - allows oneway traffic violation if the time benefit is more than 0.5 second/meter.\n* For bicycle recommended `penaltyFactor` value 0.125, for emergency 0.5.\n* Oneway traffic violations in `routeMatch=1` mode are reported as warnings.","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius (in meters) that will be applied to each waypoint.\n* If specified, overrides the `transitRadius` value set for waypoints and the default maximum adaptive search radius.\n* For routing (`routeMatch=0`), the default value is: 1600m, max limit is 5000m.\n* In `routeMatch=1` mode this parameter can be used to configure the radius that is used to match trace points to the road network, with the default value of 300m and the max limit of 10000m.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma-separated list of Map Attributes layer names used to get additional attributes along the route.\n* Only link-based attribute layers (roughly those ending in _FC1, _FC2, etc. and _FCn) are supported.\n* Specify layer with `_FCn` (like `SPEED_LIMITS_FCn`), to get content from respective functional class layer corresponding to the link.\n* After each layer name, comma separated list of individual layer attributes can be listed within brackets. Use an asterisk (*) to get all layer attributes.\n* Example: `&attributes=LINK_ATTRIBUTE_FCn(*),ROAD_GEOM_FCn(TUNNEL),SPEED_LIMITS_FCn(FROM_REF_SPEED_LIMIT,TO_REF_SPEED_LIMIT)`.\n* A maximum of 32 layers can be requested at once.","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","description":"Vehicle type for toll calculation.\n* Supported values: 1 - Motorcycle, 2 - Auto, 3 - Truck, 4 - Motor home, 5 - Minibus, 6 - Bus, 7 - Motorcycle Sidecar(EU), 8 - Tricycle(EU), 9 - Delivery Truck(EU+India), 10 - Snowmobile(US), 11 - Pick-up (US+India), 12 - Tractor (US+India), 13 = Taxi, 14 - HCM/EME (Heavy Construction Machinery/Earth Moving Equipment - India)\n* Use if applicable toll should also be calculated for the route in routeMatch=0|2 mode.\n* Or use if applicable toll should be calculated for the matched route in routeMatch=1 mode.","required":false,"schema":{"type":"string"}},{"name":"rollups","in":"query","description":"Used in `routeMatch=0|1|2`. Comma separated list of rollups (groupings, aggregation levels) for the toll cost response. Currently supported values are:\n* `none` - toll cost details per link,\n* `total` - overall total toll cost only,\n* `tollsys` - toll cost summary per toll system,\n* `country` - summary per country,\n* `country;tollsys` - summary per country and toll system.\n* Example: `&rollups=none,country;tollsys,country` - returns the individual link level cost details and two different summaries.","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","description":"Used in routeMatch=0|1|2. Comma separated list of owned passes for toll cost calculation.\n* Allows traversal of 'transponder-only' toll booths, allows cost free traversal of certain toll sections and allows using cheaper prices for transponder/pass owners.\n* Supported values: `Senior_Pass`, `transponder` (meaning the vehicle has all transponders), `allPasses` (has all required passes), `Annual` (meaning the vehicle has all annual passes), `Nr_of_Days` (has all passes valid for number of days), `Nr_of_Months` (has all passes valid for number of months), `AutoPass`, `SunPass`, `E-Z Pass` (last 2 are examples for real toll transponders).\n* Can also list toll system ids or toll booth condition ids.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Three letter ISO currency symbol. Required if toll cost must be added up across different currencies and/or be added to driver/vehicle/fuel cost in different currencies.","required":false,"schema":{"type":"string"},"example":"USD"},{"name":"departure","in":"query","description":"Specifies the time of departure for routeMatch=0|2.\n* Format: `now` or `yyyy-MM-dd'T'HH:mm:ss` or `yyyy-MM-dd'T'HH:mm:ssX`.\n* Example: `&departure=now` or `&departure=2024-10-27T11:52:50`\n* If no timezone is specified, then the local timezone at the route start link is used.\n* In routeMatch=2, the departure time for the route part is replaced by the last available GPS time from the trace.\n* If no departure parameter is set, all time dependent access restrictions are ignored.","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Only applicable when routeMatch=0. Format like parameter `departure`.\n* If an arrival time is specified, the estimated departure time of a journey is returned in the response.\n* Does not work if a departure time is specified in addition.\n* Note that toll cost is not considered when arrival time is specified.","required":false,"schema":{"type":"string"},"example":"2022-11-16T12:54:14+10"},{"name":"trafficIncidents","in":"query","description":"Used in routeMatch=0|2. Set to `true` or `false`, to enable/disable usage of traffic incidents for route estimation for complete length of the route. Default is `false` - traffic incidents are disabled.\n\n**Note:** Usage of traffic incidents will impact the routing response time, so use only if necessary.","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","description":"Used in routeMatch=0|1|2. Maximum speed allowed for the whole route.\n* Supported units are kmh (kilometres per hour), mph (miles per hour) and mps (metres per second).\n* If no unit is provided, kmh will be used as default unit.\n* Examples: `&maxSpeed=90` or `&maxSpeed=90kmh` or `&maxSpeed=55.92mph` or `&maxSpeed=25mps` .","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Only for routeMatch=0. Maximum number of alternative route options to return. Can return less or no alternatives. Only returns route alternatives that significantly differ from the best route but are not much more costly.","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","description":"Only for routeMatch=1|2. Route matching aligns the driving time to the GPS timestamps in trace (if available). Supported values: 0|1. This feature is enabled by default (1), set the value 0 to disable it.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Used in routeMatch=0|2. Comma-separated list of speeds in km/h driven per functional road class (1-5 + Virtual Connections VC) and speed category (1-8), for example, FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8.\n* Functional classes are semicolon-separated.\n* Can contain empty entries when there is no change to default ones used in the service, for example, 80,76,,,,,,;,,,54,46,,,;....\n* Overrides router's default driven speed values.\n* Predefined profiles can be activated using these values: `car`, `lightTruck`, `mediumTruck`,`heavyTruck`, `limitedWeight`, `learnIdSpeed`. \n* Example: `&speedFcCat=80,76,68,,,,,;,,,,,,,;,,,,,,,;,,,,,,,;,,,,,,,;,,,,,,,` - change the speed on FC1 roads for speed category 1 to 3 .","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","description":"Used in routeMatch=0|2. Map match tolerance (in meter) that will be applied to each way point. Routing can reach the waypoint on all links that are in the specified radius vicinity around the waypoint. Default 3.0m.","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","description":"Used in routeMatch=1|2. Option to specify that trace points without a provided speed value are ignored for matching. Default = consider all points. 1 = ignore trace points that have zero speed (only in traces that provide speed but not time).","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","description":"Used in routeMatch=1|2. For enabling calculation of spatial distance between tracepoints. Supported values: 0|1|2.\n* 0 - Default value, feature is disabled.\n* 1 - return spatial distance between matched trace points.\n* 2 - return spatial distance between original trace points","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"Trailer type in a vehicle + trailer combination. Supported values: 0 - None (Default), 1 - Caravan, 2 - Trailer, 3 - RVTrailer, 4 - BoatTrailer. Applicable for toll cost calculation and recreational vehicle restrictions.","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of vehicle axles excluding trailer axles. Applicable for toll cost calculation and country wide truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. Applicable for toll cost calculation and for country wide truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"Type of hybrid vehicle. Supported values: 1 - fuel+electric, 0 - otherwise (Default). Applicable for toll cost calculation.","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"Emission type category of the vehicle. supported values: 1 - EURO I, 2 - EURO II, 3 - EURO III, 4 - EURO IV, 5 - EURO V, 6 - EURO VI, 7 - EURO EEV, 8 - Electric Vehicles, 9 - EURO II with PRC (deprecated), 10 - EURO III with PRC (deprecated), 11 - EURO VII.\n* Applicable for toll cost calculation and environmental zone restrictions.\n* When emissionType is not specified it defaults to 5.","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. Supported values: 1 - Emission class 1, 2 - Emission class 2, 3 - Emission class 3, 4 - Emission class 4, 5 - Emission class 5.\n* Applicable for toll cost calculation only. When co2EmissionClass is not specified then it defaults to 1.\n* Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `350cm` or `3.5m` or `138in`. For toll cost calculation only, not considered for route path creation (use height parameter).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: `7.5t` or `7500kg` or `16500lbs`. See also limitedWeight. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Used in routeMatch=0|1|2. Legal maximum weight limit of vehicle incl. payload and trailers. Also including their payload as a total. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: `7.5t` or `7500kg` or `16500lbs`. Applicable for truck restrictions and requests for APPLICABLE_SPEED_LIMIT only.","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"Vehicle is signposted to to carry disabled people. Accepted values are: 1 - vehicle equipped to carry disabled people, 0 - otherwise (default). Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers in vehicle. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Total number of tires from vehicle, including tires on the base vehicle and any attached trailers. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"Vehicle use has commercial purpose. Accepted values are: 1 - vehicle registered for commercial use, 0 - no commercial use (Default: not specified). Applicable for toll cost calculation, environmental zone regulations and delivery-only zones.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"Height of the vehicle above its first axle. Example: `350cm` or `3.5m` or `138in`. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Supported values: Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric, LPG - Liquefied Petroleum Gas,  LNG - Liquefied Natural Gas).\nApplicable for environmental zone restrictions, toll cost calculation and consumption based routing for Electric vehicles.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported values: drive, single, tandem, triple, quad, quint. Example: `&weightPerAxleGroup=drive:12;single:11;tandem:18` .","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: `7.5t` or `7500kg` or `16500lbs`. See also parameter `limitedWeight`. Applicable for toll cost calculation only.","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers or semi-trailers. For toll cost and truck restrictions.\n* Supported values: 0 - no trailer (default), 1 - one or more trailers, 2 - two or more trailers, 3 - three or more trailers, 4 - one or more semi-trailers.\n* `&trailersCount=4` is not supported for Waypoint Sequencing.","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers. Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `350cm` or `3.5m` or `138in`. Applicable for truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan including their payload.\n* Accepted value units are t (tons), kg (kilograms) or lbs (pounds).\n* Example: `7.5t` or `7500kg` or `16500lbs`.\n* Applicable for truck restrictions, speed profile selection, toll cost calculation and environmental zone restrictions. See also parameter `vehicleWeight`.\n* Note that country wide weight restrictions depend on the length, width, number of axles and trailers as well, so it might be necessary to specify these parameters as well.","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from supported values: `explosive`, `gas`, `flammable`, `combustible`, `organic`, `poison`, `radioActive`, `corrosive`, `poisonousInhalation`, `harmfulToWater`, `other`, `allhazardousGoods`, `explosiveFlammable`.\n* Applicable for toll cost calculation and truck restrictions.\n* For toll cost only values `explosive` and `other` are supported.\n* For Waypoints Sequence values `allhazardousGoods` and `explosiveFlammable` are not supported.","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers).\n* Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `1250cm` or `12.5m` or `492in`.\n* Applicable for toll cost calculation and truck restrictions.\n* Note that country wide length restrictions depend on the limitedWeight, width, number of axles and trailers as well, so it might be necessary to specify these parameters  as well.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload.\n* Accepted value units are t (tons), kg (kilograms) or lbs (pounds).\n* Example: `7.5t` or `7500kg` or `16500lbs`.\n* For Waypoints Sequence only supported unit is kg, without explicitly specifying unit.\n* Applicable for toll cost calculation and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle and trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: `350cm` or `3.5m` or `138in`. Applicable for truck restrictions. Note that country wide width restrictions depend on the limitedWeight, length, number of axles and trailers as well, so it might be necessary to specify these parameters as well.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. Supported values: `B`, `C`, `D` or `E`.\n* `A` tunnels have no restrictions.\n* `E` tunnels have most restrictions.\n* Example: If `&tunnelCategory=C` is specified, then route will use `A` and `B` tunnels but not `C`, `D` or `E`.","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","description":"Used in routeMatch=0|2, to enable driver rest time calculations based on legal drive/rest intervals.\n* In `routeMatch=1` mode the response returns warnings if rest times were not detected.\n* The rest times can be specified by using the parameter _&restTimes=_ followed by one, four, five, six or ten comma separated values (no spaces).\n* Specify `&restTimes=local` (one value) to obey the legal driver rest times of the respective country where route is being traversed.\n* Example with four values: EU regulations requires that after 4.5h a 45min break and after 9h a 11h rest must be taken. This can be specified as `&restTimes=16200,2700,32400,39600` .\n* Alternatively, detailed rest time can be specified using upto ten proprietary comma separated values: _driveShortSec, timeShortSec, restShortSec, driveLongSec, timeLongSec, restLongSec, driveTimeSinceLastShortRestSec, elapsedTimeSinceLastShortRestSec, driveTimeSinceLastLongRestSec, elapsedTimeSinceLastLongRestSec_ .\n* For more detailed information and usage of this parameter, check the developer guide concepts page titled **Legal driver rest times**.'\n* In addition to normal rest time values, one can specify `;earlierRestTimeFactor:0.0`, to take rest times much earlier to reduce travel time (arriving with less legal driving time left), default = 0.75.","required":false,"schema":{"type":"string"}},{"name":"driver_cost","in":"query","description":"Used in routeMatch=0|2. Driver cost per hour in target currency. In routeMatch=0 mode, routes can be optimized based on cost by combining the driver, vehicle, and ferry costs with possible toll costs. This optimized cost is returned in the summary. Default: no driver cost given - no cost per hour optimization.","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","description":"Used in routeMatch=0|2. Cost per hour in target currency while driver is taking a legal rest time. Can be between 0 and driver_cost value. Can be used to optimize returned routes in mode routeMatch=0|2 based on cost.","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","description":"Used in routeMatch=0|2. Vehicle cost per kilometer in target currency. In routeMatch=0 mode, routes can be optimized based on cost by combining the driver, vehicle, and ferry costs with possible toll costs. This optimized cost is returned in the summary. Default: no vehicle cost given - no cost per kilometer optimization.","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","description":"Used in routeMatch=0|2. Vehicle cost per kilometer on ferry in target currency. Default = vehicle_cost. In routeMatch=0 mode, routes can be optimized based on cost by combining the driver, vehicle, and ferry costs with possible toll costs. This optimized cost is returned in the summary.","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","description":"Used in routeMatch=0|2. The cost of a consumption unit in targetCurrency. Default is 1.","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","description":"Used in routeMatch=1|2. Parameter to enable the advanced driving analytics / driving reports feature, added to the route match response (routeMatch=1).\n* Set to 1 to enable it, disabled by default.\n* For more information on this parameter and usage, check the developer guide concepts page titled **Advanced driving analytics**.\n\n**Note:** Using this feature will incur an additional transaction.","required":false,"schema":{"type":"string"}},{"name":"ehorizonLimits","in":"query","description":"Used in routeMatch=4 or routeMatch=5. Comma separated list of limitations for extending the electronic horizon path.\n* Format: `limitType:value`\n* Currently supported type is only `length` with value in meter. Example: `length:1000` .\n* For more information on this parameter and usage, check the developer guide concepts page titled **Driver alerts and Electronic Horizon**.\n\n**Note:**This feature is in development and not complete.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","description":"Used in mode routeMatch=0|2. Restrictions around waypoints can be ignored by setting value as: `radius[;drivePenaltyFactor[;type[;entryPenalty]]]`.\n* For detailed information on this parameter and its usage, please see developer guide concepts page titled **Find a path despite access restrictions**.\n* Example: `&ignoreWaypointVehicleRestriction=5000;1;all;1800` - ignore restrictions within 5 km around waypoints, with an entry penalty of 30 minutes and almost twice the driving time.\n* In mode `routeMatch=1`, a warning is returned if restriction violations are detected.","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","description":"Used in mode routeMatch=0|2. By default all admin wide truck restrictions are obeyed by the algorithm. If value is set to `ignore`, it will ignore them. Admin wide truck restriction violations in mode `routeMatch=1` are reported as warning.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Used in routeMatch=0|1|2. Route path/sections that should be avoided. Comma separated list of link ids or lat,lon[;heading] coordinates to be avoided.\n* Positive ids are avoided when driving from reference node  (start of link), negative ids are avoided when driving towards reference node  (end of link). Use '*' prefix to avoid both directions.\n* For coordinates, direction of blocking depends on the heading. If no heading given both directions will be avoided.\n* Optionally an entry penalty (applied once while entering the sequence of link(s)) and drive penalty (applied to every link) can be specified individually for each link to be avoided.\n* Format: `linkId[;penalty:entryPenaltySec[:drivePenaltyFactor]]` or `lat,lon[;heading[;penalty:entryPenaltySec[:drivePenaltyFactor]]]`.\n* `entryPenaltySec` should be between -120 and 600 (-ve penalty implies prefer).\n* `drivePenaltyFactor` should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer).\n* Example: `1308094486;penalty:60:1.5,-1308094485;penalty:2:2.5` or `50.1294,8.57124;185;penalty:60:1.5,50.12937,8.56944;177;penalty:60:1.5`.","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"Used in routeMatch=0|1|2. List of areas (rectangles or polygons) to be avoided.\n* Areas are separated by `!` sign.\n* Rectangles can be specified with two diagonal coordinates separated by semicolon. Format: `latitudeNorth,longitudeWest;latitudeSouth,longitudeEast`.\n* Polygons are specified with consecutive vertex coordinates separated by semicolon. Format: `latitude1,longitude1;laitudet2,longitude2;latitude3,longitude3;...` ","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","description":"Used in routeMatch=0|2. Option to use private streets for routing. Supported values: 0|1|-1.\n* Default is '0' - access is allowed if there is a waypoint in a street that is set for private use only.\n* Set it to '1' - always allow access to private streets.\n* Set it to '-1' - always forbid access to private streets.","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","description":"Only for routeMatch=0. Penalties in seconds to avoid unnecessary waiting time on border crossings.\n* Countries should be specified according to three character ISO 3166 standard.\n* A comma should be used to separate list of multiple avoidChangeCountry on the route.\n* Format: Country code1-Country code2:Penalty in seconds[,Country code1-Country code2:Penalty in seconds]\n* Example: `&avoidCountryChange=DEU-CHE:1200,HRV-SVN:280` - to avoid country change from Germany - Switzerland and from Croatia - Slovenia.","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","description":"Only for routeMatch=0. Preferred routes for a specific vehicle type are taken by default. To turn if off set ignorePreferredRoutes to true.","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","description":"For avoiding difficult turns on the route path.\n* Comma separated list of elements like `left[;minAngleDegree;penaltySec]` or `right[;minAngleDegree;penaltySec]` or `uTurn[;penaltySec]` .\n* If a left or right turn is sharper than the specified angle (between 0 - 180°), then the given time penalty is applied. Example: `&avoidTurns=right;120;200` .\n* If not explicitly specified in parameter, default `minAngleDegree` is set 80° and default `penaltySec` is set to 600 seconds. Example: `&avoidTurns=right` or `&avoidTurns=uTurn` .\n* For avoiding 180° turns to reverse the direction of travel (u-turns) set `uTurn` with penalty between 10 seconds and 600 seconds.  Example: `&avoidTurns=uTurn;300` .\n* Setting the value to `uTurnAtWaypoint` avoids u-turn on the link directly where the waypoint was reached.","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","description":"Used in routeMatch=0|2. Comma separated list of road features to be avoided.\n* Format: featureType[;entryPenalty;drivePenalty].\n* `entryPenalty` in seconds is applied once when the feature is avoided.\n* `drivePenalty` in seconds is applied for each km driven in avoided area.\n* `entryPenalty` and `drivePenalty` are optional. If not specified, default penalty values apply.\n* Currently supported feature type is only: `unpaved` with default `entryPenalty` of 1200 seconds (20 minutes) and `drivePenalty` of 120 seconds (2 minutes per km driven).\n* Example: `unpaved[;300;50]` - Avoids unpaved roads with 300 seconds penalty to enter and 50 seconds/km drive penalty.","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","description":"Only for routeMatch=0. Make use of truck verified roads for truck routing. Supported values: 0|1|-1.\n* Default is `0` - access is allowed, but truck verified routes are not preferred or avoided.\n* Set to `1` - prefer transport verified roads.\n* Set to `-1` - avoid transport verified roads.","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","description":"To choose the maneuver instruction text representation format in response. Supported formats are: `text` or `html`.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the maneuver instructions in the response.\n* Currently supported values:  `de-de`, `en-us`, `it-it`, `fr-fr`, `es-es`, `pt-pt`, `pl-pl`, `zh-cn`, `zh-tw`, `zh-hk` and `ja-jp`.\n* If not specified, `en-us` is used.","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","description":"Used in routeMatch=0|2. Defines which information is included in the response route part of the calculated route.\n* Defaults to mode (mo), waypoints (wp), summary (sm), flags (fl).\n* Also supported: speedProfile (sp), shape (sh), summaryByCountry (sc), boundingBox (bb), none.\n* All supported route attributes can also be excluded in the response by putting a hyphen in the front. e.g. `-wp` .","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Used in routeMatch=0|1|2, this parameter determines the information included in the response as part of the calculated route..\n* The default value is warnings (wn). Other supported options include language (lg) and none.\n* Any supported response attribute can be excluded by adding a hyphen (-) before it, e.g., `-wn`.","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the meta part of the calculated route.\n* Defaults to none. Also supported: version (ver).\n* Supported meta attributes can be excluded in the response by putting a hyphen in the front. e.g. `-ver`","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the response as part of the data representation of the route maneuvers.\n* Defaults to position (po), length (le), travelTime (tt).\n* Also supported: direction (di), action (ac), indices (ix), lanes (ln), roadName(rn), nextRoadName (nr), beforeAfter (ba) and none.\n* All supported maneuver attributes can be excluded in the response by putting a hyphen in the front. e.g. `-le`","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the response as part of the route legs.\n* Defaults to links (li), maneuvers (mn), length (le), travelTime (tt), baseTime (bt), trafficTime (tm).\n* Also supported: shape (sh), boundingBox (bb), turnbyturnmaneuvers (mm), none.\n* All supported leg attributes can be excluded in the response by putting a hyphen in the front. e.g. `-mn`.\n* Also in routeMatch=1|2 modes `legAttributes=mn` is supported.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Used in routeMatch=0|1|2. Defines which information is included in the response for each link in a leg.\n* Defaults to shape (sh), length (le), remainTime (rt), remainDistance (rd), functionalClass (fc), warnings (wn), confidence (cd), segmentRef (sr).\n* Also supported: cost (co), maneuver (ma), timezone (tz), none.\n* All supported link attributes can be excluded in the response by putting a hyphen in the front. e.g. `-rt`","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","description":"Only for routeMatch=2. Identifier of a profile that is stored as part of the Track and Route functionality.\n* The service detects stop locations and their duration from a given GPS trace.\n* For next route calculation requests, this identifier can be used for the parameter `learnedStopsId`.\n* The duration of the learned stops are then added to the pure routing time to return a more precise route ETA in case the learned stop locations are part of the next route.\n* Profile Identifiers can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them - but it makes sense to include the route description.\n* Cannot be used together with parameter `learnedStopsId`.","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","description":"Only for routeMatch=2. Identifier of an already learned profile, to be used for applying learned stop characteristics for the routing part of the Track and Route functionality.\n* Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them.\n* Cannot be used together with parameter `learnStopsId`.","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","description":"Only for routeMatch=2. If vehicle approaches a planned waypoint closer than this value in meter, then the waypoint is considered to be reached. The returned route ETA is then calculated from the vehicles current position towards the next unreached waypoint of the request. Default 20000.0m.","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","description":"Only for routeMatch=2. Defaults to `true`. This flag enables/disables the logic to analyze the GPS trace and determines which planned waypoints are skipped (not reached/visited). You can prevent waypoint skipping by setting this value to `false`.","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","description":"Only for routeMatch=2 with learned stops. Default value: 20000 meter. If the trace gets closer than this value towards a planned waypoint, then the waypoint is considered to be reached.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","description":"Only for routeMatch=2. Defaults to `true`. If set to `false` then algorithm does not ignore a trace point when it is much further away from its neighbors than the usual distance between trace points in the trace.","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","description":"Used in `routeMatch=0|1|2`. The penalty factor can be set from 0 to 100. The higher the value, the more effort is used internally to match waypoints in the given driving direction. Default = 1.","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","description":"Only for routeMatch=0, not supported for route matching. Specify if the route may not enter a specific zone type.\n* Currently supported values: `environmental`,`vignette` and `congestionPricing`.\n* If omitted or empty, zone restrictions are not taken into account.","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","description":"Used for `routeMatch=0|1|2`. Specify the licenseplate of the vehicle, which can influence the permission to drive in certain zones, mostly environmental zones. Environmental zone violations in `routeMatch=1` mode are reported as warning.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Used for `routeMatch=0|1|2`. Comma separated overlay map name(s). Used to reference towards private or adapted HERE road network attributions.\nIf an overlay is specified, the road network is used and included in the route calculation.\nIf multiple overlays are specified, they are treated as parent-child relationship. For example the parent overlay could contain the road geometry of a yard, then two different child overlays can be used to block certain road stretches dependent on the vehicle attribution.\nOverlay names are case insensitive. Must start with OVERLAY and contain only characters A-Z and numbers 0-9.\n\n**Note:** The `overlays` parameter is deprecated.","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","description":"Used for routeMatch=0|1|2. Comma separated list of key value pairs of custom restriction limits.\n* These custom restriction limits must be first uploaded into a custom road overlay.\n* The key and value of individual custom restriction limit must be numeric and must be separated by colon.\n* Example: `&customRestrLimit=0:10,1:20,2:50` .","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","description":"Comma separated list of Customer (BYOD) layer names, to get link attributes along the route. Custom layers can be uploaded in the Custom Location Service (also known as CLE) in self-hosting. Format follows the `attribute` parameter. No `FCn` notation supported.","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","description":"For mode routeMatch=0|2. Semicolon separated list of speed/ascent/descent/builtupFactor/auxilliaryConsumption fuel consumption parameters.\n* `Speed` is a list of $/km for different speeds.\n* `ascent` and `descent` are additional $/km per altitude climbed or descended.\n* `builtupFactor` is an optional heuristic consumption multiplier for urban area, default value is 1.55.\n* `auxilliaryConsumption` is the additional consumption (per hour) for running auxilliary units (climate control, infotainment, lights, etc.).\n* Cost unit is not $ but one specified in parameter 'currency'.\n* Example: `speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108;ascent,0.4;descent,0.1;builtupFactor,1.4`. This means at 70 kph the car consumes 6.6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area.\n* Alternatively, user can specify one of the default consumption profile using following supported values: 3.5t, 7.5t, 18t, 40t or weightDependent.\n* If specified as `weightDependent`, consumption profile will be decided based on vehicle weight in parameter `limitedWeight`. So, this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Custom timeout of a request. Processing of the request must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","description":"Only for routeMatch=1. Set it to '1' or '0' to enable/disable provisioning a set of coordinates to reconstruct the journey using routing. A coordinate will be collected after each junction, if a minimum distance travelled since previous. This distance is by default 50m and can be changed by the sub-parameter minDist:, but not below 25m. Example: &pathCoordinates=1,minDist=30","required":false,"schema":{"type":"string"}},{"name":"waypointN","in":"query","description":"Only for modes routeMatch=0|2. Generic waypoint parameter to indicate the format. For routeMatch=1 trace to be matched should be added as POST body.\n* Waypoints should start with 'waypoint0' and increase in sequence (waypoint1, waypoint2..) to waypointN.\n* A route must consist of at least 2 waypoints (start and destination).\n* The maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time.\n* Format: latitude,longitude;transitRadius;label;heading[;optional specifications]\n* Set a transit radius to only influence the route to go via a certain city (Example: `&waypoint1=50.12,8.65;10000)`.\n* Set a heading (degree clockwise from North) to improve map matching (Example: `&waypoint0=latitude,longitude;;;140`).\n* To define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: `&waypoint1=stopOver,300!50.12,8.65`).\n* The optional specifications: altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\n* To define a radius around the waypoint where vehicle restrictions should be ignored use optional specification `;ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]`. Example: `&waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800` .\n* This is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied.","schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","schema":{"type":"string"}},{"name":"apikey","in":"query","description":"A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .\nOther authentication options are Bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Required only for routeMatch=1|2. Trace file for route matching, supported trace formats - GPX, NMEA, KML, CSV or GeoJSON.\nPlease refer the developer guide page titled **GPS trace formats and accuracy** for detailed information on trace file formats and supported trace attributes.","content":{"text/plain":{"schema":{"type":"string"},"example":"timestamp,latitude,longitude\n2024-04-02T15:50:56.248Z,59.30820,18.07631\n2024-04-02T15:51:13.903Z,59.30780,18.07644\n2024-04-02T15:51:19.558Z,59.30771,18.07566\n2024-04-02T15:51:25.213Z,59.30759,18.07451\n2024-04-02T15:51:54.348Z,59.30759,18.07451\n2024-04-02T15:51:59.448Z,59.30652,18.07478"}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/v8/maps/overlays/upload":{"post":{"tags":["Route Matching V8"],"summary":"Submit an overlay map for customized route matching.- Deprecated","description":"Submit an overlay map with custom modifications, such as block road links, remove restrictions from road links, or insert new road links into the network. The modifications that you submit, as part of your overlay maps, are only visible to you but not to other customers. Also, these modifications are not uploaded to the official HERE map. Route matching can consider overlay maps. Note: This feature is deprecated.","operationId":"HERE Route Matching V8 API overlayUploadV8","parameters":[{"name":"overlay_spec","in":"query","description":"mandatory (unless in POST body). string. JSON structure describing the map changes.","required":true,"schema":{"type":"string"}},{"name":"point_order_obeys_one_ways","in":"query","description":"optional. true/false. If true then geometry is not matched onto links if it is against the legal driving direction.","required":false,"schema":{"type":"boolean"}},{"name":"multidigitized_handling","in":"query","description":"optional. If ACCESS specified then access restrictions of the overlay get applied into both driving direction. Per default they are applied into the direction of the order of points given. Can also be specified per overlay operation (parameter multidigitizedHandling)","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"optional. string. Currently only readonly is supported.","required":false,"schema":{"type":"string","default":"readonly"}},{"name":"mapName","in":"query","description":"Mandatory. String. Overlay map name, and layer name within this map. Case insensitive. Must start with OVERLAY and contain only characters. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":false,"schema":{"type":"string"}},{"name":"private_link_handling","in":"query","description":"optional. string. Three values are supported: PLAIN = normal behavior (default), UNCONNECTED = don't connect new links to existing private links (use to avoid connecting new links to an unrelated neighboring facility), DROPEXISTING = block the existing private links (use if an existing link overlaps with a new link and is less","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_match","in":"query","description":"optional. number. Specifies how many meters apart the geometries of two new links can be, to establish a connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_connect","in":"query","description":"optional. number. Specifies how many meters apart the geometries of a new link and an existing link can be, to establish connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"min_match_confidence","in":"query","description":"optional, default 0.6. 0.0 ... 1.0. Specify the minimum required road match confidence level. If a match is below this level, the service throws an error.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"optional. string. Specifies the name of a user-defined function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"fullTable","in":"query","description":"optional, default 'true'. Set to 'false' if the layer upload response time is too big otherwise. If 'false' then /search/all.json will not work on this layer.","required":false,"schema":{"type":"string","default":"true"}},{"name":"max_match_search_distance","in":"query","description":"optional. number. Default 100 meter. Specifies how many meters around a given point to search for existing geometries. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"matchMode","in":"query","description":"optional. 0 or 1. Default 0. 0 does sophisticated geometry match. 1 does a quicker check which is usually sufficient if the geometries fit exactly to the existing road network.","required":false,"schema":{"type":"string"}},{"name":"parent_overlay","in":"query","description":"optional. Overlay map name to be used as a base on top of whch to apply this overlay submission.","required":false,"schema":{"type":"string"}},{"name":"id_space_offset","in":"query","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","description":"API key used to authenticate requests.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An overlay description file consists of a JSON array with JSON objects. Each JSON object describes a single map modification operation. For more details, please check the documentation page with title 'Customize and augment the road network' under 'Concepts'.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSerializable"},"example":[{"op":"restrict","shape":[[50.08562,8.58945],[50.08447,8.58847]],"type":"access","bidirectional":"true","data":{"HEIGHT_RESTRICTION":"200","DATE_TIMES":"1:N:N:XXXXXXX ::0000:0700"}}]}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlaySubmitResponse"}}}}}}}},"components":{"schemas":{"BaseResponse":{"type":"object"},"BoundingBox":{"type":"object","properties":{"topLeft":{"$ref":"#/components/schemas/Coordinate"},"bottomRight":{"$ref":"#/components/schemas/Coordinate"}}},"Coordinate":{"type":"object","properties":{"latitude":{"type":"number","format":"double","example":48.33294},"longitude":{"type":"number","format":"double","example":8.13556}}},"CostDetails":{"type":"object","properties":{"driverCost":{"type":"string","description":"computed from request's driver_cost value and the travel time (with or without ferry time)","example":"430.8"},"vehicleCost":{"type":"string","description":"computed from request's vehicle_cost value and the travel distance (with or without ferry travel)","example":"330.0"},"tollCost":{"type":"string","description":"total toll fee","example":"130.1"},"optionalValue":{"type":"string","description":"value earned by picking + dropping optional waypoints"},"energyCost":{"type":"string","description":"computed based on request's consumptiondetails","example":"233.75"},"totalCost":{"type":"number","format":"double","example":500.55}}},"Costs":{"type":"object","properties":{"totalCost":{"type":"string","description":"sum of all cost elements","example":"1335.7"},"currency":{"type":"string","description":"currency unit of the costs","example":"EUR"},"details":{"$ref":"#/components/schemas/CostDetails"}}},"CurrencyAmount":{"type":"object","properties":{"country":{"type":"string","description":"country is the three letter ISO 3166 country code."},"adminId":{"type":"string","description":"adminId is the country's admin place id.","example":"DEU"},"tollSystemId":{"type":"string","description":"tollSystemId is the unique toll system identifier."},"name":{"type":"string","description":"Toll system name"},"languageCode":{"type":"string","description":"Language code of toll system name"},"amountInTargetCurrency":{"type":"number","format":"double"}},"description":"totalCost is the sum of all cost elements."},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"object"}},"description":"requested PDE layer attributes for the link"},"Leg":{"type":"object","properties":{"length":{"type":"integer","format":"int32"},"travelTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int32","example":3800},"link":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"maneuver":{"type":"array","items":{"$ref":"#/components/schemas/Maneuver"}},"shape":{"type":"array","items":{"type":"number","format":"double"}},"boundingBox":{"$ref":"#/components/schemas/BoundingBox"},"trafficTime":{"type":"integer","description":"travel time [sec] considering traffic impact (use only if mode=traffic:enabled)","format":"int32"},"baseTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int32"},"refReplacements":{"type":"object","additionalProperties":{"type":"string"}},"legShape":{"type":"array","writeOnly":true,"items":{"type":"number","format":"double"}},"firstPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.","format":"int32","example":0},"lastPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the last point of the shape subsegment associated with this Maneuver. Must be preceded by FirstPoint.","format":"int32"},"turnByTurnManeuver":{"type":"array","items":{"$ref":"#/components/schemas/TurnByTurnManeuver"}},"stayingTime":{"type":"integer","description":"Indicates time spent on recharging(in seconds). Only available if the maneuver has a chargingStopOver.","format":"int32"},"arrivalBatteryCharge":{"type":"number","description":"Indicates battery energy when reaching the recharge waypoint. Only available if the maneuver has a chargingStopOver.","format":"double","example":8.56},"targetBatteryCharge":{"type":"number","description":"Indicates battery energy after charging when leaving the recharge waypoint. Only available if the maneuver has a chargingStopOver.","format":"double"}},"description":"one leg traverses between two mandatory stopover waypoints"},"Link":{"type":"object","properties":{"linkId":{"type":"string","description":"Permanent version id (HERE core map), negative sign means driven towards reference node"},"length":{"type":"number","description":"Returns the link length in meter (to match HLS router response) or in centimeter - depending on the setting passed in the constructor.","format":"double"},"remainDistance":{"type":"number","description":"meters left when entering this link, for the entire route (not just in between legs)","format":"double"},"remainTime":{"type":"number","description":"Seconds left when entering this link, for the entire route (not just in between legs). Millisecond precision if link attributes PRECISETIMEDISTANCE requested.","format":"double"},"shape":{"type":"array","description":"List of WGS84 degree latitude/longitude coordinates in driving direction sequence order","items":{"type":"number","description":"List of WGS84 degree latitude/longitude coordinates in driving direction sequence order","format":"double"}},"functionalClass":{"type":"integer","description":"Functional Class defines a hierarchical network used to determine a logical and efficient route.","format":"int32"},"confidence":{"type":"number","description":"0...1 link match confidence (only for route match mode)","format":"double"},"attributes":{"type":"object","additionalProperties":{"type":"array","description":"requested PDE layer attributes for the link","items":{"type":"array","description":"requested PDE layer attributes for the link","items":{"$ref":"#/components/schemas/KeyValue"}}},"description":"requested PDE layer attributes for the link"},"cost":{"$ref":"#/components/schemas/CostDetails"},"remainingDistanceToDestinationCentimeter":{"type":"integer","format":"int64","writeOnly":true},"warning":{"type":"array","items":{"$ref":"#/components/schemas/ResponseIssue"}},"consumption":{"type":"number","description":"energy consumption to traverse the link, in target currency","format":"double"},"timezone":{"type":"integer","description":"Timezone offset to UTC in minutes when the time zone of the link changes compared to previous link","format":"int32"},"segmentRef":{"type":"string","description":"<CatalogID> : <CatalogVersion> : <SegmentID> # <+-> OffsetFrom .. OffsetTo where the +- indicates whether the segment is driven algined with the order of its coordinates"}}},"Maneuver":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/ManeuverPosition"},"instruction":{"type":"string","description":"tagged driver instruction text in the requested language","example":"Head West on M1 / Pacific Mtwy. Go for 56 m."},"instructionBefore":{"type":"string"},"instructionAfter":{"type":"string","example":"After 56 m, take the exit onto 24"},"travelTime":{"type":"integer","description":"Time [sec] to drive until to this maneuver point","format":"int32","example":150},"length":{"type":"integer","description":"Distance [meter] to drive until to this maneuver point","format":"int32"},"id":{"type":"string"},"direction":{"type":"string","description":"Indicates whether directions should be included in the maneuvers. Supported directions are: forward, lightRight, right, hardRight, uTurnRight, lightLeft, left, hardLeft, uTurnLeft."},"action":{"type":"string","description":"Indicates whether actions should be included in the maneuvers. Supported actions are: depart, arrive, slightLeftTurn, leftTurn, sharpLeftTurn, leftUTurn , continue, slightRightTurn, rightTurn, sharpRightTurn, rightUTurn, RoundaboutExit, exit, uTurn, turn, keep.","example":"leftTurn"},"firstPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.","format":"int32","example":2},"lastPoint":{"type":"integer","format":"int32"},"lanes":{"type":"string","description":"List of lane infos, viewed into driving direction, from left to right. Applicable lanes marked '*', n = not allowed for vehicle or direction, numbers denote arrows, see Map Attributes layer LANE_FCn attribute DIRECTION_CATEGORY."},"roadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}},"nextRoadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}}}},"ManeuverPosition":{"type":"object","properties":{"latitude":{"type":"number","format":"double","example":48.33294},"longitude":{"type":"number","format":"double","example":18.13294}}},"MatchedVehicleType":{"type":"object","properties":{"type":{"type":"string","description":"car, truck or pedestrian","example":"truck"},"subType":{"type":"string","description":"light, medium or heavy, applicable only for truck"},"confidence":{"type":"number","description":"confidence value of the match 0 ... 1","format":"double"}},"description":"Most probable vehicle type(s), only for route match mode. Only returned if the input trace contains speed or timestamp information."},"Pass":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the pass. Id could change from one map release to another.","format":"int32"},"annual":{"type":"boolean","description":"Indicates whether the pass is valid for a year or not."},"extendedAnnual":{"type":"boolean","description":"Indicates whether the pass is valid for a year plus the month prior to the specified year and the month following the specified year (Dec-Jan)."},"nrOfDays":{"type":"integer","description":"Indicates The number of days the pass is valid for.","format":"int32"},"nrOfMonths":{"type":"integer","description":"Indicates the number of months the pass is valid for.","format":"int32"},"seniorPass":{"type":"boolean","description":"Indicates whether the pass is valid for Senior people only."},"nrOfTravels":{"type":"integer","description":"Indicates the number of travels the pass is valid for.","format":"int32"}}},"Response":{"type":"object","description":"Calculate route response","allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"route":{"type":"array","description":"Route alternatives. The first route alternative has the minimum cost.","readOnly":true,"items":{"$ref":"#/components/schemas/Route"}},"language":{"type":"string","description":"Language used in maneuver instructions. 2 letter language code + 2 letter ISO country code.","readOnly":true,"example":"en-us"},"warnings":{"type":"array","description":"Warnings that are either globally for the request or apply to the first route alternative.","readOnly":true,"items":{"$ref":"#/components/schemas/ResponseIssue"}}}}]},"ResponseIssue":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","format":"int32"},"truckRestrictionCategoryCode":{"type":"integer","format":"int32"},"isoCountryCode":{"type":"string"},"routeLinkSeqNum":{"type":"integer","format":"int32"},"tracePointSeqNum":{"type":"integer","format":"int32"},"wayPointSeqNum":{"type":"integer","format":"int32"},"toTracePointSeqNum":{"type":"integer","format":"int32"},"duration":{"type":"integer","format":"int64"},"plannedWayPointSeqNum":{"type":"integer","format":"int32"},"operation":{"type":"string"}},"description":"Warnings that are either globally for the request or apply to the first route alternative.","readOnly":true},"RoadName":{"type":"object","properties":{"language":{"type":"string","description":"Language used in maneuver instructions. 2 letter ISO 639-1 language code + 2 letter ISO 3166-1 alpha-2 country code."},"text":{"type":"string","example":"M1 / Pacific Mtwy"}}},"Route":{"type":"object","properties":{"waypoint":{"type":"array","items":{"$ref":"#/components/schemas/WayPoint"}},"mode":{"$ref":"#/components/schemas/RouteMode"},"leg":{"type":"array","description":"one leg traverses between two mandatory stopover waypoints","items":{"$ref":"#/components/schemas/Leg"}},"shape":{"type":"array","description":"route shape geometry points - lat, lon pairs","items":{"type":"number","description":"route shape geometry points - lat, lon pairs","format":"double"}},"summary":{"$ref":"#/components/schemas/Summary"},"boatFerry":{"type":"boolean","description":"set if the route uses a boat ferry"},"railFerry":{"type":"boolean","description":"set if the route uses a rail ferry"},"routeFlagsInResponse":{"type":"boolean","writeOnly":true},"boundingBox":{"$ref":"#/components/schemas/BoundingBox"},"cost":{"$ref":"#/components/schemas/Costs"},"matchedVehicleType":{"type":"array","description":"Most probable vehicle type(s), only for route match mode. Only returned if the input trace contains speed or timestamp information.","items":{"$ref":"#/components/schemas/MatchedVehicleType"}},"tollCost":{"$ref":"#/components/schemas/TCResponse"},"summaryByCountry":{"type":"array","items":{"$ref":"#/components/schemas/RouteSummaryByCountry"}}},"description":"Route alternatives. The first route alternative has the minimum cost.","readOnly":true},"RouteMode":{"type":"object","properties":{"type":{"type":"string","description":"from request: shortest, fastest or matched (route match mode)"},"transportModes":{"type":"array","description":"request's vehicle type","example":"[car]","items":{"type":"string","description":"request's vehicle type","example":"[car]"}},"trafficMode":{"type":"string","description":"from request: disabled or enabled","example":"disabled"}},"description":"from the request"},"RouteSummaryByCountry":{"type":"object","properties":{"distance":{"type":"integer","description":"travel distance [meter]","format":"int64"},"baseTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int64"},"trafficTime":{"type":"integer","description":"travel time [sec] considering traffic impact (use only if mode=traffic:enabled)","format":"int64"},"travelTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int64","example":360},"country":{"type":"string","description":"ISO 3166 country code","example":"DEU"},"tollRoadDistance":{"type":"integer","description":"toll road distance [meter]","format":"int64"}}},"RouteTollItem":{"type":"object","properties":{"linkIds":{"type":"array","description":"Sequence of link ids covered by this toll fee","items":{"type":"integer","description":"Sequence of link ids covered by this toll fee","format":"int64"}},"tollType":{"type":"string","description":"Uppercase letter (A=admin wide, F=system with km/weight/fixed fee, K=kilometer between toll booths based, S=pay per booth or pair of booths) indicates that payment happens here while lowercase tollType=p just informs that toll fee exists, but is not paid on this road stretch. The upper case tollType=U means there is toll applicable for certain vehicle types, but the actual cost is not known. The lower case tollType=a denotes section where admin toll cost is applicable, but already paid at the first link of the route in this admin (which gets tollType=A)."},"country":{"type":"string","description":"3 letter ISO 3166 country code","example":"DEU"},"adminId":{"type":"integer","description":"Admin place id of the country","format":"int32"},"tollSystem":{"type":"array","items":{"$ref":"#/components/schemas/TSystem"}},"conditionId":{"type":"integer","description":"Core map condition id, either type Toll Both or Usage Fee Required","format":"int32"},"tollStructures":{"type":"array","description":"Toll booth(s)/bridge(s) at start and/or end of this toll section","items":{"$ref":"#/components/schemas/TollStructure"}},"tollCostAlternatives":{"type":"array","description":"toll fee alternatives, depending on vehicle type, time of day, day of week, month, payment method, pass, transponder...","items":{"$ref":"#/components/schemas/TollCost"}},"usageFeeRequiredTime":{"type":"string","description":"Date/time definition when this toll fee applies, in the same format as in all map layers' DATE_TIMES fields"},"topologySegmentIds":{"type":"array","items":{"type":"integer","format":"int64"}},"fromSegmentIndex":{"type":"integer","description":"Index of the first input segment id covered by this toll fee.","format":"int32"},"toSegmentIndex":{"type":"integer","description":"Index of the last input segment id covered by this toll fee.","format":"int32"}},"description":"routeTollItems are a list of all toll cost items (for rollups=none)."},"Summary":{"type":"object","properties":{"travelTime":{"type":"integer","description":"travel time [sec]","format":"int64","example":455},"distance":{"type":"integer","description":"travel distance [meter]","format":"int64"},"baseTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int64"},"trafficTime":{"type":"integer","description":"travel time [sec] considering traffic impact (use only if mode=traffic:enabled)","format":"int64"},"flags":{"type":"array","description":"currently unused","example":"boatFerry","items":{"type":"string","description":"currently unused","example":"boatFerry"}},"departure":{"type":"string","description":"same or later than request's departure time","example":"2022-11-16T12:54:14+10"},"arrival":{"type":"string","description":"same or earlier than request's arrival time"}}},"TCResponse":{"type":"object","properties":{"routeTollItems":{"type":"array","description":"routeTollItems are a list of all toll cost items (for rollups=none).","items":{"$ref":"#/components/schemas/RouteTollItem"}},"costsByTollSystem":{"type":"array","description":"costsByTollSystem is the total toll cost per toll system.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"costsByCountry":{"type":"array","description":"costsByCountry is the total toll cost per country.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"costsByCountryAndTollSystem":{"type":"array","description":"costsByCountryAndTollSystem is the total toll cost per country and toll system.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"totalCost":{"$ref":"#/components/schemas/CurrencyAmount"}},"description":"the requested toll cost rollups"},"TSystem":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"languageCode":{"type":"string"}}},"TollCost":{"type":"object","properties":{"amount":{"type":"number","description":"fee in native currency unit","format":"double"},"currency":{"type":"string","description":"the native currency unit"},"amountInTargetCurrency":{"type":"number","format":"double"},"levelOfAccuracy":{"type":"string","description":"Indicates the accuracy of the toll amount, if it is either ESTIMATED or AVERAGE."},"time":{"type":"string","description":"Standard core map specification for validity periods. Examples: 1:N:N:XXXXXXX:0112:0000:0730,1:N:N:XXXXXXX:0112:1400:1600, 2:N:N:EASTER::800:1800, A:N:N:20021013:20200101:1000:1900, C:N:N:00010000:00050000:1230:1330, H:N:N:00010000:00120000:500:2400 I:N:N:00010010:00110010:1730:2400"},"methodOfPayment":{"type":"integer","description":"bitmask: 1=cash, 2=bank card, 4=credit card, 8=pass subscription, 16=transponder, 32=video toll charge, 64=exact cash, 128=travel card","format":"int32"},"pass":{"$ref":"#/components/schemas/Pass"},"daylightHours":{"type":"integer","description":"Indicates if toll cost is applicable during daylight hours or during non-daylight hours. 0=non-daylight, 1=daylight, 2=unspecified","format":"int32"},"discountAvailable":{"type":"integer","description":"Indicates if under specific circumstances discounts or exemption apply to this standard toll cost. 0=no, 1=yes","format":"int32"},"returnJourney":{"type":"integer","description":"Indicates whether the specified toll cost includes a return trip or not. 0=no, 1=yes","format":"int32"},"ferryType":{"type":"string","description":"Indicates the type of ferry that is operating: either BOAT FERRY, RAIL FERRY or HOVERCRAFT FERRY."},"vehicleSpecification":{"$ref":"#/components/schemas/VehicleSpecification"},"transponderNames":{"type":"array","description":"List of transponder names for which the specific cost is applicable","items":{"type":"string","description":"List of transponder names for which the specific cost is applicable"}}},"description":"toll fee alternatives, depending on vehicle type, time of day, day of week, month, payment method, pass, transponder..."},"TollStructure":{"type":"object","properties":{"name":{"type":"string"},"languageCode":{"type":"string","example":"DEU"},"latitude":{"type":"number","format":"double","example":48.33294},"longitude":{"type":"number","format":"double","example":18.13294},"linkIds":{"type":"array","items":{"type":"integer","format":"int64"}},"topologySegmentIds":{"type":"array","items":{"type":"integer","format":"int64"}},"conditionId":{"type":"integer","format":"int32"}},"description":"Toll booth(s)/bridge(s) at start and/or end of this toll section"},"TracePoint":{"type":"object","properties":{"linkId":{"type":"string"},"mappedPosition":{"$ref":"#/components/schemas/Coordinate"},"originalPosition":{"$ref":"#/components/schemas/Coordinate"},"spot":{"type":"number","description":"0...1 relative matched offset on link from reference node","format":"double"},"confidenceValue":{"type":"number","description":"Confidence value for this point match (probability of match correctness). Value between 0.0 (high risk of matching to a wrong link) and 1.0 (very likely the matched link is the correct one). Currently the confidence value is simply derived from the distance between the original and the matched coordinate, but this will be refined in future releases.","format":"double"},"elevation":{"type":"number","description":"Original GPS trace point elevation in meter height above the WGS84 reference ellipsoid. This value is taken from the request, and provided in the response for convenience.","format":"double"},"headingDegreeNorthClockwise":{"type":"number","description":"Original GPS trace point heading (aka bearing or direction), in degree against North, clockwise. This value is taken from the request, and provided in the response for convenience. 10000 if not provided in the trace.","format":"double"},"headingMatched":{"type":"number","description":"Heading of the road section at the matched position. Degree against North, clockwise.","format":"double"},"matchDistance":{"type":"number","description":"Distance between the original trace point and the matched coordinate, in meter.","format":"double"},"minError":{"type":"number","description":"Meter distance to the nearest road. This is a lower bound for the combined inaccuracy of GPS signal and map. 1000000.0 if it was not computed for this point.","format":"double"},"routeLinkSeqNrMatched":{"type":"integer","description":"Sequence number of the matched link within the route path. Starting at zero.","format":"int32"},"speedMps":{"type":"number","description":"Original GPS trace point speed value, in meter per second (independent of the originally provided unit). This value is taken from the request, and provided in the response for convenience.","format":"double"},"applicableSpeedLimitKph":{"type":"integer","description":"Only for drivingReport=1, speed limit for this vehicle at this date/time, including country wide general limits [kph]","format":"int32"},"timestamp":{"type":"integer","description":"Milli seconds since 1/1/1970 UTC, unmodified from original trace, zero if trace contained no timestamps.","format":"int64"},"globalWayPointSeqNr":{"type":"integer","format":"int32"},"distToPrev":{"type":"number","description":"Spatial distance to previous original trace point, in meter.","format":"double"},"distToPrevMatched":{"type":"number","description":"Spatial distance to previous matched coordinate, in meter.","format":"double"},"breakDetected":{"type":"boolean","description":"Only available with restTimes parameter. Indicates a break is detected at this waypoint"},"breakDuration":{"type":"integer","description":"Only available with restTimes parameter. Duration of a break in milliseconds detected at this waypoint","format":"int64"},"warning":{"type":"array","items":{"$ref":"#/components/schemas/ResponseIssue"}},"lateralAccelerationMpss":{"type":"number","description":"Only for drivingReport=1, lateral acceleration by centrifugal force [mpss]","format":"double"},"accelerationMPSS":{"type":"number","description":"Only for drivingReport=1, longitudinal vehicle acceleration [mpss], breaking if negative","format":"double"},"solarAltitudeAngle":{"type":"number","description":"Only for drivingReport=1, vertical sun position angle versus the flat earth surface [degree], 90 to -90, 0 = straight into driver's eyes","format":"double"},"solarRelAltitudeAngle":{"type":"number","description":"Only for drivingReport=1, vertical sun position angle versus the current road surface considering the road slope and heading [degree], 90 to -90","format":"double"},"solarRelHorizontalAngle":{"type":"number","description":"Only for drivingReport=1, horizontal sun position angle versus the driving direction [degree], 0 = straight into driver's eyes, 180 = in the back mirror","format":"double"},"waypointType":{"type":"string","description":"Indicates waypoint type: `plannedWaypoint` - planned intermediate waypoint; `learnedStop` - waypoint derived from the driver's rest patterns learned by the API; `lastTracepoint` - the last position of the vehicle known by the API, often its current location."},"type":{"type":"string","description":"Indicates waypoint type: `passThrough` for a waypoint that doesn't stop the journey, `stopOver` for a waypoint at which the journey stops for some time before it continues."},"sideOfStreet":{"type":"string","description":"Indicates whether the waypoint is located on the left or right side of the link in the direction of travel. Possible values are \"left\", \"right\", or \"neither\".<br/>The \"neither\" value indicates that the waypoint is within three meters of the link or segment, which represents the centerline of a road section on the map. Three meters is approximately the width of a typical lane. This parameter is only available if the routeMatch=0 parameter was set."},"mappedRoadName":{"type":"string","description":"Base name of the road. Empty means unknown or valid unnamed. Only available if parameter routeMatch=0 was set."},"shapeIndex":{"type":"integer","description":"index of the first shape coordinate in the shape array","format":"int32"},"userLabel":{"type":"string","description":"Waypoint label specified by user."}}},"TurnByTurnManeuver":{"type":"object","properties":{"routeLinkIndex":{"type":"integer","format":"int32"},"position":{"$ref":"#/components/schemas/ManeuverPosition"},"action":{"type":"string","description":"Indicates whether actions should be included in the maneuvers. Supported actions are: depart, arrive, slightLeftTurn, leftTurn, sharpLeftTurn, leftUTurn , continue, slightRightTurn, rightTurn, sharpRightTurn, rightUTurn, RoundaboutExit, exit, uTurn, turn, keep.","example":"leftTurn"},"orientation":{"type":"string"},"roadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}},"nextRoadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}},"distanceToNextManeuver":{"type":"integer","format":"int32"},"firstPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.","format":"int32","example":2},"lastPoint":{"type":"integer","format":"int32"},"travelTime":{"type":"integer","description":"Time [sec] to drive until to this maneuver point","format":"int32","example":150},"instruction":{"type":"string","description":"tagged driver instruction text in the requested language","example":"Head West on M1 / Pacific Mtwy. Go for 56 m."},"instructionBefore":{"type":"string"},"instructionAfter":{"type":"string","example":"After 56 m, take the exit onto 24"},"length":{"type":"integer","description":"Distance [meter] to drive until to this maneuver point","format":"int32"},"id":{"type":"string"},"direction":{"type":"string","description":"Indicates whether directions should be included in the maneuvers. Supported directions are: forward, lightRight, right, hardRight, uTurnRight, lightLeft, left, hardLeft, uTurnLeft."},"lanes":{"type":"string","description":"List of lane infos, viewed into driving direction, from left to right. Applicable lanes marked '*', n = not allowed for vehicle or direction, numbers denote arrows, see Map Attributes layer LANE_FCn attribute DIRECTION_CATEGORY."}}},"VehicleSpecification":{"type":"object","properties":{"trailerType":{"type":"string"},"hybrid":{"type":"boolean"},"emissionType":{"type":"string"},"disabledEquipped":{"type":"boolean"},"hov":{"type":"boolean"},"commercial":{"type":"boolean"},"personFee":{"type":"boolean"},"tollVehicleType":{"type":"string"},"trailersCount":{"type":"integer","format":"int32"},"vehicleNumberAxlesMin":{"type":"integer","format":"int32"},"vehicleNumberAxlesMax":{"type":"integer","format":"int32"},"trailerNumberAxlesMin":{"type":"integer","format":"int32"},"trailerNumberAxlesMax":{"type":"integer","format":"int32"},"heightMin":{"type":"integer","format":"int32"},"heightMax":{"type":"integer","format":"int32"},"trailerHeightMin":{"type":"integer","format":"int32"},"trailerHeightMax":{"type":"integer","format":"int32"},"vehicleWeightMin":{"type":"integer","format":"int32"},"vehicleWeightMax":{"type":"integer","format":"int32"},"limitedWeightMin":{"type":"integer","format":"int32"},"limitedWeightMax":{"type":"integer","format":"int32"},"minimalPollution":{"type":"boolean"},"passengersCountMin":{"type":"integer","format":"int32"},"passengersCountMax":{"type":"integer","format":"int32"},"tiresCountMin":{"type":"integer","format":"int32"},"tiresCountMax":{"type":"integer","format":"int32"},"shippedHazardousGoods":{"type":"string"},"heightAbove1stAxleMin":{"type":"integer","format":"int32"},"heightAbove1stAxleMax":{"type":"integer","format":"int32"},"lengthMin":{"type":"integer","format":"int32"},"lengthMax":{"type":"integer","format":"int32"},"fuelType":{"type":"string"},"co2EmissionClass":{"type":"integer","format":"int32"}}},"WayPoint":{"type":"object","allOf":[{"$ref":"#/components/schemas/TracePoint"},{"type":"object","properties":{"linkId":{"type":"string"},"mappedPosition":{"$ref":"#/components/schemas/Coordinate"},"originalPosition":{"$ref":"#/components/schemas/Coordinate"},"spot":{"type":"number","description":"0...1 relative matched offset on link from reference node","format":"double"},"sideOfStreet":{"type":"string","description":"Indicates whether the waypoint is located on the left or right side of the link in the direction of travel. Possible values are \"left\", \"right\", or \"neither\".<br/>The \"neither\" value indicates that the waypoint is within three meters of the link or segment, which represents the centerline of a road section on the map. Three meters is approximately the width of a typical lane. This parameter is only available if the routeMatch=0 parameter was set."},"seqNrOnRoute":{"type":"integer","description":"index of the link in the route (duplicate link entries at start/end of a leg are counted only once)","format":"int32"},"globalWayPointSeqNr":{"type":"integer","format":"int32"},"waypointType":{"type":"string","description":"Indicates waypoint type: `plannedWaypoint` - planned intermediate waypoint; `learnedStop` - waypoint derived from the driver's rest patterns learned by the API; `lastTracepoint` - the last position of the vehicle known by the API, often its current location."},"type":{"type":"string","description":"Indicates waypoint type: `passThrough` for a waypoint that doesn't stop the journey, `stopOver` for a waypoint at which the journey stops for some time before it continues."},"mappedRoadName":{"type":"string","description":"Base name of the road. Empty means unknown or valid unnamed. Only available if parameter routeMatch=0 was set."},"shapeIndex":{"type":"integer","description":"index of the first shape coordinate in the shape array","format":"int32"},"userLabel":{"type":"string","description":"Waypoint label specified by user."}}}]},"JsonSerializable":{"type":"object"},"OverlaySubmitResponse":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"layers":{"type":"array","description":"Names of map layers generated from the overlay submission","items":{"type":"string","description":"Names of map layers generated from the overlay submission"}},"meta":{"type":"array","items":{"$ref":"#/components/schemas/SearchMetaResponse"}}}},"SearchMetaResponse":{"type":"object","properties":{"searchParameter":{"type":"string","writeOnly":true},"layerId":{"type":"string","description":"Layer name of geometries in a search response.","example":"ADAS_ATTRIB_FC4"},"lastUpdateTimeStamp":{"type":"integer","description":"last modification milli second timestamp for this layer. Only valid for custom layers, -1 for HERE map layer","format":"int64","example":1756219305792}}}},"headers":{"X-Correlation-Id":{"description":"Auto-generated id that uniquely identifies the request.","schema":{"type":"string"},"example":"8230d7ad-3f1c-4191-a8dd-f3c42026da89"},"X-Request-Id":{"description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","schema":{"type":"string"},"example":"4199533b-6290-41db-8d79-edf4f4019a74"}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"A key generated specifically to authenticate API requests. For more information on how to get an API key, see [Identity and Access Management Developer Guide](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide).","name":"apiKey","in":"query"},"bearerTokenAuth":{"type":"http","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. For more information on how to get a bearer token, see the [Identity and Access Management Developer Guide](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide).","scheme":"bearer","bearerFormat":"JWT"}}}}