GET /v1/autocomplete/location

HTTP Method: GET

Path: /v1/autocomplete/location

Authentication: API Key required

Description: Get suggestions as to how the supplied string can be auto-completed as a category name.

Parameters:

parameter type description Required
str string The parital string that needs auto-completing e.g. dubli yes
country string The ISO country code of the supplied string e.g. ie for Eire no

Sample Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "suggestions": [{
            "name": "clonsilla co dublin"
        }, {
            "name": "co dublin"
        }, {
            "name": "county dublin"
        }, {
            "name": "dublin"
        }, {
            "name": "dublin airport"
        }, {
            "name": "north dublin"
        }, {
            "name": "south dublin"
        }],
        "from_cache": true
    }
}

The data element contains an array of suggestions that match your supplied partial string.

version 2 as of 6 years ago by Glynn Bird

Docs Navigation