How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HERE Profile Mode API

The Profile Mode API from HERE — 1 operation(s) for profile mode.

HERE Profile Mode API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profile Mode. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 29 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.

1 operations 1 paths 29 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
8.49.0
Base URL
https://account.api.here.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

HERE Profile Mode 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Profile Mode 1
GET
/profiles/{profileId}
Get profile definition by its ID
getProfile 2 params → 200401403404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Vehicle (28 properties), Profile (10 properties), Avoid (7 properties), ErrorMessage (6 properties). Each schema is shown below with its type and property counts.

Profile
object
A profile specifies predefined request options that can be used for matrix routing in the whole world.
10 properties
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 properties 1 required
CountryCode
string
ISO-3166-1 alpha-3 code
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…
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…
TollTransponders
string
Polygon
object
A polygon defined as a list of coordinates.
2 properties 2 required
BoundingBox
object
A bounding box defined by two longitudes and two latitudes.
5 properties 5 required
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…
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 property 1 required
EncodedPolygon
object
A [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string that defines the outline of the polygon.
2 properties 2 required
Vehicle
object
28 properties
ErrorMessage
object
6 properties 6 required
Circle
object
Region definition variant defining a circle around a coordinate on Earth.
3 properties 3 required
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…
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…
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 properties 2 required
AutoCircle
object
Region definition variant defining an automatically derived circle. The resulting circle contains all origins and destinations with a margin.
3 properties 1 required
AuthError
object
Error object reported in case of authentication or authorization errors.
2 properties
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.

Source

here-profile-mode-api-openapi.yml Raw ↑

Other APIs HERE publishes across the network.

HERE Geocoding and Search API
HERE Autosuggest API
HERE Tour Planning API
HERE Public Transit API
HERE Destination Weather API
HERE Map Tile API
HERE Map Image API
HERE Tracking API
HERE Positioning API
HERE Parking API
HERE Platform Data API
HERE HD Live Map
Where this information came from

This is an independent, third-party profile of HERE Profile Mode 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.