Batch Geocoder API Developer's Guide

Quick start - HERE platform

This section outlines how to quickly get started using the Batch Geocoder API.
  1. Get a HERE account
  2. Create a project
  3. Configure your project
  4. Send a request
Note: This section provides information on the minimum setup required to quickly begin using the Batch Geocoder API. For more detailed information on HERE account setup, project creation, service linking, app registration, and authentication, see the Identity & Access Management Developer 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. Enter an optional description.
  7. Click Save.

Configure your project

To configure your project, which involves linking the Batch Geocoder API services you want to use, adding an app to the project, and generating credentials for the app, follow these steps:
  1. On the Resources tab, select Services and then click Link a Service.
  2. Search for Batch Geocoder API service(s) and click Link.
  3. Click Done.
  4. Select the Access and permissions tab and click Grant access.
  5. Under New app, select Create.
  6. Provide an app name and click Register. The platform creates a new app with a unique app ID.
  7. 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

This is an example that demonstrates how to send a request.
To request the corresponding geocoordinates for a list of complete addresses, you need to perform the following steps:
  • Upload your data.
  • Wait until the geocoding process is done, alternatively check the job status.
  • Download the results.
Note: This quick start only shows the first step in this process. For examples of the other steps, see Get job status and Get job results.
To upload the data, send the following POST request:
https://batch.geocoder.ls.hereapi.com/6.2/jobs
?apiKey={YOUR_API_KEY}
&indelim=%7C
&outdelim=%7C
&action=run
&outcols=displayLatitude,displayLongitude,locationLabel,
  houseNumber,street,district,city,postalCode,county,
  state,country
&outputcombined=false
POST body
recId|searchText|country
0001|Invalidenstraße 116 10115 Berlin|DEU
0002|Am Kronberger Hang 8 65824 Schwalbach|DEU
0003|425 W Randolph St Chicago IL 60606|USA
0004|One Main Street Cambridge MA 02142|USA
0005|200 S Mathilda Ave Sunnyvale CA 94086|USA

The response to the above request includes the following high level elements:

  • RequestId that identifies the job created for the request which you can use to track the job progress and to request the results when the job is complete.
  • The status of this job.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:SearchBatch xmlns:ns2="http://www.navteq.com/lbsp/Search-Batch/1">
  <Response>
    <MetaInfo>
      <RequestId>qr9jVjuoFe1mULUvBlXr7UK4dM8BpAkO</RequestId>
    </MetaInfo>
    <Status>accepted</Status>
    <TotalCount>0</TotalCount>
    <ValidCount>0</ValidCount>
    <InvalidCount>0</InvalidCount>
    <ProcessedCount>0</ProcessedCount>
    <PendingCount>0</PendingCount>
    <SuccessCount>0</SuccessCount>
    <ErrorCount>0</ErrorCount>
    </Response>
    </ns2:SearchBatch>