Route Match Extension API Developer's Guide

Match Route

Resource URI

/matchroute (.json / .txt)

Resource Parameters

Parameter Type Mandatory Description
app_id string Y Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.
app_code string Y Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.
file string GET Base64 encoded string that contains the (zipped or plain) trace file content. Zipped can be PKZip (used by zip, WinZip, 7Zip etc) or ZLib (used by deflate) format. Only used for GET requests. In POST requests, the file is sent as request body, not Base64 encoded, plain or zipped. Note 1: Browsers limit the size of the file to a few KB when passed in a GET request. Note 2: To reduce the POST response size, the HTTP request headers TE: gzip,deflate and Accept-encoding: gzip,deflate should be set, and if the response header Content-encoding: gzip is present then the response is gzipped.
filetype string N File format of GPS trace, either of GPX, CSV, NMEA or KML. For more information, see Trace File Formats.

Default: The service will guess the format

routemode string N Specifies the vehicle type. Supported values are car, bus, taxi, carHOV, pedestrian, truck, delivery, emergency, motorcycle and roadtrain. Can also be a comma separated list of vehicle types, meaning "not sure which of those vehicle types it was, allow everything that either vehicle can". For more information, see Legal Routes.

Default: car

legal string N Enforces a legal route w.r.t. the listed maneuver types. Supported maneuver types (to be passed as comma separated list) are access,gate,oneway,thrutraf,turn. Passing all of them yields a legal route like a router would generate. access only uses road links the vehicle type (incl. truck specifications if provided) is allowed to access. gate prevents traversing gates. oneway prevents driving links into forbidden direction. thrutraf prevents entering and leaving 'no through traffic' zones. turn prevents illegal turns incl. illegal u-turns and truck specifications if provided. For more information, see Legal Routes.

Default: avoid illegal maneuvers, but use them if the trace obviously used them. If used, return respective warnings.

trailersCount number N Specifies the number of trailers the vehicle has. Route Match Extension API will avoid and penalize illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning. For more information, see Legal Routes.

Default: Assume no trailers.

Note: Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.
shippedHazardousGoods string N Specifies what type of hazardous goods the truck carried. Supported values are explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. Route Match Extension API will avoid and penalize illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning. For more information, see Legal Routes.

Default: Assume no hazardous goods.

Note: Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.
limitedWeight number N Specifies the vehicle height in centimeter. Route Match Extension API will avoid and penalize illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning. For more information, see Legal Routes.

Default: Ignore weight restrictions.

Note: Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.
weightPerAxle number N Specifies the vehicle weight per axle in kilogram. Route Match Extension API will avoid and penalize illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning. For more information, see Legal Routes.

Default: Ignore weight restrictions.

Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.

height number N Specifies the vehicle height in centimeters. Route Match Extension API avoids and penalizes illegal maneuvers, but you can use them if the trace obviously used them. If used, return a respective warning. For more information, see Legal Routes.

Default: Ignore height restrictions.

Note: Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.
width number N Specifies the vehicle width in centimeters. Route Match Extension API will avoid and penalize illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning. For more information, see Legal Routes.

Default: Ignore width restrictions.

Note: Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.
length number N Specifies the vehicle length in centimeters. Route Match Extension API will avoid and penalize illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning. For more information, see Legal Routes.

Default: Ignore length restrictions.

Note: Truck aware route matching is a premium feature. For information on pricing and plans, contact your account executive.
linkaccess string N Specifies a comma separated list of link IDs. Route Match Extension API will assume that the given vehicle type(s) are allowed to access these links, regardless of the link access coding or link access restricting conditions in the map, including truck specific restrictions like weight. However, it doesn't relax one way or turn restrictions. Route Match Extension API avoids and penalizes illegal maneuvers, but use them if the trace obviously used them. If used, it returns a corresponding warning. For more information, see Legal Routes.
avoidLinks string N Specifies a comma separated list of link IDs. Route Match Extension API will not drive these links into the specified direction. Positve link IDs are not driven from reference node, negative link IDs are not driven towards reference node.
attributes string N Specifies a comma separated list of PDE layer names. Only those PDE layers are supported that contain information on links, roughly those who end with _FC1, FC2, ... FC5. Instead of the functional class digit, the letter n is used to denote that all 5 layers are ment. Each PDE layer name is followed by a comma separated list of attributes in brackets, or just (*) to ask for all attributes of the layer. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn(FROM_REF_SPEED_LIMIT,TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn(SLOPES).

Default: No additional attributes in the response.

Note: PDE layer information along the route is a premium feature. For information on pricing and plans, contact your account executive.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.