GET /v1/autocomplete/document-field/{index public key}

Retrieve word completion data from custom fields.

Required Query Parameters

Paramenter	Description	Type	Notes
term	Autocomplete prefix	string	A term to autocomplete
source	Array of custom fields you wish to search	string	Only custom fields of data-type text are accepted
size	The number of suggestions to return	int	Default value is 10

Sample Request

https://api.addsearch.com/v1/autocomplete/document-field/{index public key}?term=go&source=custom_fields.fashion_brand

Response

{
  "autocomplete": [
    {"value":"Golden Lighting"},
    {"value":"Golfino"},
    {"value":"Gottex"},
    {"value":"42 Gold"},
    {"value":"ÁLVARO GONZÁLEZ"}
  ]
}

Field	Description	Type
autocomplete	Top level, the returned autocompletions	object, an object or an array of objects

Please note that the Autocomplete API endpoint does not require authentication.

The default rate limit for the Autocomplete API is 5 requests/sec from a single IP address. Higher rate limit can be requested from the support.