Suggest whole addresses

GET

/geocode/suggest

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

Up to eight UK addresses that match what has been typed so far (at least three characters), nearest the business’s first base first, as a label to show and a placeId. Never kept: picking one is GET /geocode/place/{placeId}, which gives the lines to fill the form with. available is false where this installation has no address service; the form is then typed. At most 120 a minute for a business (429).

Authorizations

• sessionCookie
  tenant:read
• apiKey
  tenant:read

Parameters

Query Parameters

q

required

string

<= 200 characters

Responses

200

Suggestions

Media typeapplication/json

object

available

required

boolean

items

required

Array<object>

object

label

required

string

placeId

required

string

Example^generated

{
  "available": true,
  "items": [
    {
      "label": "example",
      "placeId": "example"
    }
  ]
}

401

Not signed in

Media typeapplication/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

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

429

Too many in a minute

Media typeapplication/json

object

error

required

string

message

required

string

Example

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