List the addresses at a postcode

GET

/geocode/addresses

const url = 'https://example.com/geocode/addresses?postcode=example';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/geocode/addresses?postcode=example' \
  --cookie bottle.session_token=<bottle.session_token>

Every door at a postcode, laid out ready for a form, where this installation has a key for the address file; available is false where it has not, and the form falls back to typing. Either way the postcode itself is checked and written properly.

Authorizations

sessionCookie
tenant:read
apiKey
tenant:read

Parameters

Query Parameters

postcode

required

string

>= 2 characters <= 10 characters

Responses

200

The addresses, or the news that there is no list here

application/json

object

available

required

boolean

postcode

required

object

normalised

required

string | null

known

required

boolean

items

required

Array<object>

object

label

required

string

line1

required

string

line2

required

string | null

city

required

string | null

postcode

required

string

latitude

required

number | null

longitude

required

number | null

Example

{
  "items": [
    {
      "label": "14 High Street, New Malden, KT3 4BP"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}