Get started

This section outlines how to quickly get started using the HERE Route Matching REST API on the HERE platform.

  1. Get a HERE account
  2. Create a project
  3. Get an API key
  4. Send a request


This section provides information on the minimum setup required to quickly begin using HERE Route Matching. For more detailed information on HERE account setup, project creation, service linking, app registration, and authentication, see the Identity & Access Management Guide.

Get a HERE account

If your organization has signed up for HERE Workspace or HERE Marketplace, contact your organization admin who can invite you to join the HERE platform organization established for your company. You can also request a free trial of the HERE platform if your company does not have an organization established for it. For more information, see the HERE platform pricing.

Create a project

To create a project, follow these steps:

  1. Sign in to the HERE platform using your HERE account.
  2. Open the Projects Manager from the launcher.
  3. Click Create new project.
  4. Enter a name for the project. Project names don't have to be unique.
  5. Enter a project ID. Project IDs must be unique within an organization and cannot be changed for the lifetime of the organization. Project IDs must be between 4 and 16 characters in length.
  6. Optional: Enter an optional description.
  7. Click Save.

Get an API key

To get an API key, follow these steps:

  1. On the Resources tab, select Services and then click Link a Service.
  2. Search for HERE Route Matching service(s) and click Link.
  3. Optional: Search for additional services and click Link to link them to your project as needed.
  4. Click Done.
  5. Select the Access and permissions tab and click Grant access.
  6. Under New app, select Create.
  7. Provide an app name and click Register. The platform creates a new app with a unique app ID.
  8. On the Credentials tab, select API Keys and then click Create API key to generate a maximum of two API Keys for your application authentication credentials. The API key is created and displayed.

Send a request

It is recommended to use POST requests wherever possible.

If the amount of waypoints queried in a GET request gets too large, the request returns a 414 8.1.10 message

For authentication, one of the following parameters is mandatory:

  • apiKey
  • LEGACY: app_id and app_code combination

Note: For the available authentication options, see the Identity & Access Management Developer Guide.

The following table provides some example requests.


When opening the links in the following table, press F12 in your browser to view the relevant REST requests as used in the related use case demos.

Link to example Resource Parameters
Match GPS Trace /v8/calculateroute.json &routeMatch=1
Match GPS Trace, show match confidence /v8/calculateroute.json &routeMatch=1
Match GPS Trace, show speeding alerts /v8/calculateroute.json + /1/tile.json &routeMatch=1

Next steps

For a full list of available examples, see Examples. For the terms and conditions covering this documentation, see the HERE Documentation License. Data privacy is of fundamental importance to HERE and our customers. We practice data minimization and don’t collect data we don’t need. And we promote pseudonymity for data subjects wherever a service does not require personal information to function. We employ privacy by design in services we develop. We strive to go beyond mere regulatory compliance and make privacy an integral part of our corporate culture. We believe that our approach to privacy is vital to earning and retaining the trust of our customers – and the bedrock of our future success as a data-driven location platform. For more information on how data privacy is of fundamental importance to HERE and our customers, see the HERE Privacy Charter.

results matching ""

    No results matching ""