GET /v1/autocomplete/keyword

HTTP Method: GET

Path: /v1/autocomplete/keyword

Authentication: API Key required

Description: Get suggestions as to how the supplied string can be auto-completed as a category name or as a keyword. The difference between this method and GET /v1/autocomplete/category is that this one returns the categories in our taxonomy AS WELL as keywords in our database that are synonyms of one or more categories.

Parameters:

parameter type description Required
str string The parital string that needs auto-completing e.g. rest yes
language string The ISO language code of the supplied string e.g. en for English no

Sample Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "suggestions": [{
            "name": "antique restoration"
        }, {
            "name": "antique restorers"
        }, {
            "name": "antique restoring"
        }, {
            "name": "cafe restaurant"
        }, {
            "name": "classic car restoration"
        }, {
            "name": "fire & flood restoration"
        }, {
            "name": "floor restoration"
        }, {
            "name": "restaurant"
        }, {
            "name": "vintage car restoration"
        }, {
            "name": "wood floor restoration"
        }]
    }
}

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

version 2 as of 6 years ago by Unknown

Docs Navigation