v1

latestOpenAPI 3.0.02026-07-1498671635.3 KB

publicly-accessible

Get auto-completed search terms

Provides auto-completed search terms for restaurants, cuisines and products available in a given location.

get/search/autocomplete/{tenant}

Path parameters

tenantstring required

A valid country code, e.g. "uk".

Query parameters

searchTermstring required

User's search term - at least one character required

latlongnumber[] required

The latitude and longitude coordinates of the location in which to search. Specify the coordinates as latitude,longitude.

limitnumber

Limit the number of auto-completed terms returned by the API. Defaults to 7. Valid values 1 - 10

Response

Success

Example response

{
  "terms": [
    {
      "classification": "Restaurant",
      "term": "Pizza Palace"
    },
    {
      "classification": "Cuisine",
      "term": "Pizza"
    },
    {
      "classification": "Dish",
      "term": "Large Hawaiian"
    }
  ]
}