Get started
Get a HERE account
You can get started with a free HERE platform account from the flexible HERE Base Plan. For more information, see the HERE Base Platform Pricing. Alternatively, if your company has already established a HERE platform organization, contact your organization admin who can invite you to join your company's organization.
Create a project
- Sign in to the HERE platform using your HERE account.
- Open the Projects Manager from the launcher.
- Click Create new project.
- Enter a name for the project. Project names don't have to be unique.
- 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.
- Enter an optional description.
- Click Save.
Get an API key
To get an API key, follow these steps:
- Sign in to the HERE platform using your HERE account.
- Select the Access Manager from the launcher.
- Select the Apps tab and click Register new app.
- Enter a name for the app.
- Optional: Enter a description for the app.
- Optional: Select the project you created in the previous procedure from the Default access to a project field.
- Click Register. The HERE platform creates a new app with a unique app ID.
- 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.- Upload your data.
- Wait until the geocoding process is done, alternatively check the job status.
- Download the results.
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
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>
Next steps
We encourage you to explore the following topics to learn how to succesfully use Batch Geocoder API: