Batch Geocoder API Developer's Guide

API Endpoints

Table 1. Batch Geocoder Request Endpoints
URL Request Description HTTP Method
jobs

<The HTTP Body of the request contains the data to be geocoded.>

  • Creates a batch job
  • Returns a RequestID
POST
jobs/{REQUEST_ID}?action=run&params=... Starts the batch job with the given parameters. PUT
jobs?action=run&params=...

<The HTTP Body of the request contains the data to be geocoded.>

  • Creates a batch job
  • Starts the job
  • Returns a RequestID
(shortcut for jobs and jobs/...?action=run)
POST
jobs/{REQUEST_ID}?action=cancel Cancels the batch job. PUT
jobs/{REQUEST_ID}?action=status Returns the status for the batch job . GET
jobs/{REQUEST_ID} Deletes the batch job.

Note that the difference between this request and others is the HTTP type, which is DELETE. You do not use an action to delete a job.

DELETE
jobs/{REQUEST_ID}/result Starts a download of all files.

The result file contains all geocoded results. If "OutputCombined" is specified, this will also contain "no-matches". Errors are not included.

GET
jobs/{REQUEST_ID}/errors Starts a download of the error file.

The errors file contains all invalid lines from the input data.

GET
jobs/{REQUEST_ID}/no-matches Download all results that the geocoder could not match to an address ("no-match")

Downloads the no-matches file only.

GET
jobs/{REQUEST_ID}/all Downloads all available files in one zip file
Downloads all the files:
  • result,
  • errors (optional)
  • invalid
  • report
GET

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.