Batch Geocoder API Developer's Guide

Get started - HERE developer portal

This section outlines how to quickly get started using the Batch Geocoder API on the HERE developer portal.

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, app registration, and authentication, see the Identity & Access Management Developer Guide.

Get a HERE Account

If you are an individual developer who has signed up for one of the plans listed on our Developer plans page on developer.here.com, you received a HERE account ID when you signed up. You can use your HERE account to log in to developer.here.com to create applications. Applications (uniquely identified by an app ID) enable development with HERE products and services.

Register Your App

To register your app, follow these steps:

Sign in to developer.here.com.
Click your name, select Projects, and then choose your project from the list. Your project details and available application credentials are then displayed.
Click Create API key to generate a maximum of two API keys for your application. The API key is created and displayed.

Get an API Key

To get an API key, follow these steps:

Sign in to developer.here.com.
Click your name, select Projects, and then choose your project from the list. Your project details and available application credentials are then displayed.
Click Create API key to generate a maximum of two API keys for your application. 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>

Related Information

Constructing a request