API Reference

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

Retrieve word completion data from custom fields.

Required Query Parameters

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"}
  ]
}

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.

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.