Calculation of routing matrices in one of the following modes:* Flexible* Region* ProfileThe values of the `regionDefinition` and `profile` parameters determine which mode is used.The following table describes the capabilities and limitations of each mode.| Mode | regionDefinition parameter | profile parameter provided? | Custom Options & Time Awareness(incl. live traffic) | Unlimited region | Matrix size limit(synchronous) | Matrix size limit(asynchronous) ||----------|------------------------------|-------------------------------|---------------------------------------------------------|-------------------------------------------------------------------------------|------------------------------------|-------------------------------------|| Flexible | `world` | no | yes | yes | 15 x 100 or 100 x 1 | 15 x 100 or 100 x 1 || Region | one of:`circle``boundingBox``polygon``autoCircle`| no | yes | noorigins and destinations must be within a region of max 400 km diameter | 500 x 500 | 10,000 x 10,000 || Profile | `world` | yes | no | yes | 500 x 500 or 1 x 2000 or 2000 x 1 | 10,000 x 10,000 |Note that the combination of specifying a `profile` along with a `regionDefinition` not equal to `world` is not allowed.## Synchronous vs. Asynchronous RequestsMatrix requests can be synchronous or asynchronous.Use the `async` query parameter to indicate the request type. All 3 modesare compatible with both synchronous and asynchronous requests.Synchronous requests impose additional limitations on maximum matrix sizes (see table above).
HERE Matrix Calculation API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Matrix Calculation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 3 paths,
and defines 52 schemas.
It is described by OpenAPI 3.2.0, at version 8.49.0.
Requests are made against a single base URL, https://matrix.router.hereapi.com/v8.
3 operations3 paths52 schemas2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
HERE Matrix Calculation API declares
2 security schemes
for authenticating requests.
An API key is passed in the query as apiKey (ApiKey).
It accepts HTTP bearer tokens (JWT) (Bearer).
By default, every request must be authenticated.
ApiKey — A key generated specifically to authenticate API requests. For more information on how to get an API key, see the [Identity and Access Management Developer Gui…
Bearer — 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 to…
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Matrix Calculation 3
Calculation of routing matrices in one of the following modes: Flexible Region Profile The values of the regionDefinition and profile parameters determine which mode is used.
POST
/matrix
Submit matrix for calculation
postMatrix2 paramsbody→ 200202400401403413429500
GET
/matrix/{matrixId}/status
Status of submitted matrix calculation
getMatrixStatus2 params→ 200303401403404500
GET
/matrix/{matrixId}
Result of successfully completed calculation
getMatrix3 params→ 200303400401403404406500
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Vehicle (28 properties), Truck (28 properties), MatrixRequest (22 properties), Waypoint (11 properties). Each schema is shown below with its type and property counts.
StateCode
object
Country code according ISO 3166-1 alpha-3 code and array of its state codes according to ISO 3166-2.
AvoidZoneCategories
object
Specify avoidance of entire categories of routing zones, with the provision to add individual exceptions. Note: Zones that don't apply to the current vehicle a…
2 properties1 required
ArrivalTime
string
Time of arrival at a destination, in ISO 8601 (RFC 3339) format: the time zone offset is required, e.g., 2025-08-06T11:20:00+02:00 arrivalTime can not be used…
CountryCode
string
ISO-3166-1 alpha-3 code
SideOfStreetHint
object
A hint as to which side of the street should be preferred for this waypoint. This hint should be a point next to the street, e.g. a POI
3 properties2 required
ViolationMappingItemTraffic
object
3 properties2 required
EVPhysicalModel
object
Specifies parameters required for calculation of energy consumption for electric vehicles using physical model.
5 properties3 required
Matrix
object
Calculated matrix
7 properties2 required
Avoid
object
Avoid routes that violate these properties.
7 properties
Area
Defines an explicit area to avoid/exclude when calculating the routes. Areas to be avoided/excluded can be specified by boundingBoxes or polygons (as an encode…
ViolationMappingOptionalField
string
Defines how a specific violation attribute should be handled within a violation mapping. Use: include: the violated restriction is added to a mapped category i…
RoutingMode
string
Specifies which optimization is applied during the calculation. fast: Route calculation from start to destination optimized by travel time. In many cases, the…
MatrixResponse
object
3 properties1 required
TruckType
string
Specifies the type of truck. straight: a truck on a single frame with a permanently attached cargo area tractor: a towing vehicle that can pull one or more sem…
TollTransponders
string
Polygon
object
A polygon defined as a list of coordinates.
2 properties2 required
BoundingBox
object
A bounding box defined by two longitudes and two latitudes.
5 properties5 required
ViolationMappingItem
Generic base type for violation mappings. Violation mappings belong to either of two categories. Mappings belonging to the same category are evaluated together…
Taxi
object
1 property
World
object
Unbounded region referring to the whole world. The world region is only supported when a predefined profile is specified and no other options are provided. For…
1 property1 required
EncodedPolygon
object
A [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string that defines the outline of the polygon.
2 properties2 required
Vehicle
object
28 properties
DepartureTimeWithAny
string
Time of departure at all origins, in ISO 8601 (RFC 3339) format: the time zone offset is required, e.g., 2025-08-06T11:20:00+02:00 When departureTime is not sp…
ErrorMessage
object
6 properties6 required
EVEmpiricalModel
object
Specifies parameters required for calculation of energy consumption for electric vehicles using Empirical model.
6 properties2 required
ViolationMappingItemAvoidAreasAndSegments
object
2 properties2 required
Pedestrian
object
1 property
Truck
object
28 properties
Circle
object
Region definition variant defining a circle around a coordinate on Earth.
3 properties3 required
ViolationMappingItemRestriction
object
7 properties2 required
ConsumptionSpeedTableEntry
object
2 properties
Exclude
object
Defines properties which will be strictly excluded from route calculation. Note - Exclude options guarantees exclusion, but doesn't guarantee finding a route.
3 properties
TransportMode
string
Depending on the transport mode special constraints, speed attributes and weights are taken into account during route calculation. car: Route calculation for c…
MatrixStatus
object
5 properties2 required
MatrixRequest
object
22 properties2 required
Allow
object
Explicitly allow features that require users to opt in.
2 properties
AvoidFeatures
array
"avoid": {"features": [...]}: Array of features avoided during matrix calculation. Available avoid feature options: seasonalClosure tollRoad controlledAccessHi…
ConsumptionSpeedTable
array
Function curve specifying consumption rate at a given speed, where speed values are strictly increasing. The table is an array specifying data points along the…
MaxSpeedOnSegment
array
Segments with restrictions on maximum baseSpeed. Notes: Maximum amount of penalized segments in one request cannot be greater than 1000. "Penalized segments" r…
Coordinate
object
2 properties2 required
AutoCircle
object
Region definition variant defining an automatically derived circle. The resulting circle contains all origins and destinations with a margin.
3 properties1 required
Traffic
object
Traffic specific parameters.
2 properties
Scooter
object
1 property
Waypoint
object
WSG-84 coordinates with additional metadata
11 properties2 required
Distance
integer
Distance in meters
AuthError
object
Error object reported in case of authentication or authorization errors.
2 properties
EV
object
EV properties to be used only when requesting consumptions in matrixAttributes. Note: Access to the consumptions feature is currently restricted. If you would…
Areas
array
List of explicit areas to avoid/exclude when calculating the routes. Notes: Maximum count of avoided and excluded polygons is 20. Maximum total count of avoide…
RegionDefinition
Definition of a region in which the matrix will be calculated. Only the data inside of the region will be used for the calculation of the matrix. All origins a…
WeightPerAxleGroup
object
Specifies the weights of different axle groups, like single and tandem axles. This allows specification of axle weights in a more fine-grained way than weightP…
5 properties
VehicleType
string
Specifies the type of the vehicle straightTruck: A truck on a single frame with a permanently attached cargo area. Note: default value when truck routing mode…
LicensePlate
object
Specifies the information about the vehicle's license plate number. This information is used to evaluate whether certain vehicle restrictions in environmental…
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of HERE Matrix Calculation API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
