API Reference

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

Retrieve word completion data from custom fields.

Required Query Parameters

termAutocomplete prefixstringA term to autocomplete
sourceArray of custom fields you wish to searchstringOnly custom fields of data-type text are accepted
sizeThe number of suggestions to returnintDefault value is 10

Sample Request

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


  "autocomplete": [
    {"value":"Golden Lighting"},
    {"value":"42 Gold"},
    {"value":"ÁLVARO GONZÁLEZ"}
autocompleteTop 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.

Was this helpful?

Need more help?

We’re always happy to help with code or other questions you might have. Search our documentation, contact support, or connect with our sales team.