HERE Route Matching V8 API

{"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 ins

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-route-matching-v8-openapi.json