Skip to content
Naurt Docs

Post

POST
/rendezvous/v1

Rendezvous takes a list of queries, finds delivery clusters, and returns cluster centres plus the covered addresses for each cluster.

This is not a routing tool. It does not provide delivery order or route optimisation.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
queries
required

List of Query objects. The Query object is shared across Naurt APIs. Different query types may be mixed in the same request.

Array<object>
<= 200 items

Shared Naurt Query object.

The Rendezvous spec refers to the shared Search Query specification. At minimum, address-based queries such as address_string are supported. Other shared query forms may also be accepted.

object
address_string

Free-form address query string

string
latitude
number
longitude
number
key
additional properties
any
Example
{
  "address_string": "18a, Montague Place, Brighton, BN2 1JE, United Kingdom"
}
options

Optional Rendezvous request options

object
key
additional properties
any
Examples

Example address batch

{
  "queries": [
    {
      "address_string": "18a, Montague Place, Brighton, BN2 1JE, United Kingdom"
    },
    {
      "address_string": "Flat 9, Montague Court, Montague Street, Brighton, BN2 1NQ, United Kingdom"
    },
    {
      "address_string": "28 Hereford Street, Brighton, BN2 1JT, United Kingdom"
    },
    {
      "address_string": "4378twbv5934wy 9q87v3ncyq9nv eriyuib4478twtvwbeihsecfonreniren vt9nhyutrevuhtvnuhitr"
    },
    {
      "address_string": "27 Hereford Street, Brighton, BN2 1JT, United Kingdom"
    },
    {
      "address_string": "28 Essex Street, Brighton, BN2 1JW, United Kingdom"
    },
    {
      "address_string": "Flat 31, Martlet Court, Hereford Street, Brighton, BN2 1LQ, United Kingdom"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful clustering response

object
responses
required
Array<object>
object
centre
required
object
id
required
string
address
required

Normalised address; may differ from the searched address

string
geojson
required
object
features
required
Array<object>
>= 1 items <= 4 items
object
geometry
required
One of:
object
coordinates
required
Array<number>
>= 2 items <= 2 items
type
required
string
Allowed values: Point
properties
required
object
naurt_type
required
string
Allowed values: basic_geocode naurt_door naurt_building naurt_parking
accuracy
object
quality
required
string
Allowed values: low medium high
minimum_parking_to_door_distance
number format: double
type
required
string
Allowed values: Feature
type
required
string
default: FeatureCollection
Allowed values: FeatureCollection
distance

Distance in metres from the searched latitude/longitude. Present only when searching with latitude and longitude.

number | null format: float
covers
required
Array<object>
object
id
required
string
address
required

Normalised address; may differ from the searched address

string
geojson
required
object
features
required
Array<object>
>= 1 items <= 4 items
object
geometry
required
One of:
object
coordinates
required
Array<number>
>= 2 items <= 2 items
type
required
string
Allowed values: Point
properties
required
object
naurt_type
required
string
Allowed values: basic_geocode naurt_door naurt_building naurt_parking
accuracy
object
quality
required
string
Allowed values: low medium high
minimum_parking_to_door_distance
number format: double
type
required
string
Allowed values: Feature
type
required
string
default: FeatureCollection
Allowed values: FeatureCollection
distance

Distance in metres from the searched latitude/longitude. Present only when searching with latitude and longitude.

number | null format: float
unmatched
required

Queries that could not be matched

Array<object>

Shared Naurt Query object.

The Rendezvous spec refers to the shared Search Query specification. At minimum, address-based queries such as address_string are supported. Other shared query forms may also be accepted.

object
address_string

Free-form address query string

string
latitude
number
longitude
number
key
additional properties
any
Example
{
  "address_string": "18a, Montague Place, Brighton, BN2 1JE, United Kingdom"
}
version

API version used to service the request

string | null
request_id

Request identifier useful when reporting issues to Naurt. Mentioned in the prose docs, though not shown in the response shape block.

string | null

400

Section titled “400 ”

Bad request

401

Section titled “401 ”

Missing or invalid API key

500

Section titled “500 ”

Internal server error