Retrieving Coordinates for an Address or a Postcode

Requests

In order to get coordinates a HTTP GET request with one of the following parameter-sets must be made to the geocoding service.

Request path

GET /locations/coordinates?<parameters>

Request parameters for postcode + country:

Name Required Notes
postcode true -
countrycode true ISO 3166 alpha-2/3 compliant country code

Request parameters for line-based address

Name Required Notes
line1 true -
line2 false -
line3 false -
line4 false -
postcode true -
countrycode true ISO 3166 alpha-2/3 compliant country code

Request parameters for a structured address

Name Required Notes
company_name false -
door_code false -
house_nr true -
house_ext false -
floor false -
building false -
street true -
city false -
area false -
district false -
province false -
postcode true -
countrycode true ISO 3166 alpha-2/3 compliant country code

Response

HTTP/1.1 200 OK
{
    "latitude": 51.5663394349283,
    "longitude": -0.129791390131075
}

Failure

Invalid parameter combination or data types submitted:

HTTP/1.1 400 BAD REQUEST

User doesn't have the required permission:

HTTP/1.1 403 FORBIDDEN

Not found:

HTTP/1.1 404 NOT FOUND

When service is unavailable. Retrying the request may work:

HTTP/1.1 503 SERVICE UNAVAILABLE

Other errors:

HTTP/1.1 500 INTERNAL SERVER ERROR

results matching ""

    No results matching ""