Geocode

Geocode is a collection of geocode related endpoints.

This includes endpoints that allow to normalise and geocode addresses to get highly accurate results that are also validated and improved by real drivers every day.

The level of quality of geocoding is defined by the accuracy level returned to the accuracy.level field.

The following are the different accuracy levels currently supported:

Accuracy Level Score Description
ADDRESS_POINT 100 Address is accurate to the house door or rooftop
MANUAL_GEOCODING 95 The address was manually geocoded by a Bettermile employee using multiple sources of information.
STREET_COORDINATES 90 The address was translated to street coordinates derived from the geocoder result.
INTERPOLATED_POINT 80 Location was calculated using interpolation between two known points.
STREET_CENTROID 50 Location was geocoded to the center of the street.
POSTAL_CENTROID 30 Location was geocoded to the center of the postal code.
LOCALITY_CENTROID 10 Location was geocoded to the center of the locality.

Geocode

The Geocode endpoint returns information regarding an address. This broadly includes coordinates, formatted address, accuracy information and much more.

SecuritybasicAuth
Request
query Parameters
debug
boolean

to get naId and gaId specify debug parameter like this ?debug. The value can be true or false

Request Body schema: application/json
object

A specified period of time in which is planned a delivery to take place.

object

Address Object to be normalized and geocoded.

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout Error - All third party geocoders are unreachable. Try again later

post/api/v1/geocode
Request samples
application/json
{
  • "timeframe": {
    },
  • "address": {
    }
}
Response samples
application/json
{
  • "rawAddressId": 12345,
  • "timeframe": {
    },
  • "coordinates": {
    },
  • "streetCoordinates": {
    },
  • "entranceCoordinates": {
    },
  • "parkingCoordinates": {
    },
  • "formatted": "Otto-Weidt-Platz 8, 10557 Berlin, Germany",
  • "street": "Otto-Weidt-Platz",
  • "number": 8,
  • "postalCode": 10557,
  • "locality": "Berlin",
  • "countryCode": "DE",
  • "accuracy": {
    },
  • "zoneId": "Europe/Berlin"
}