API Reference

GET /v1/suggest/{index public key}

Retrieve search suggestions from the index.

Required Query Parameter

  • term: Search suggestion prefix

Optional Query Parameter

  • size: Number of search suggestions to return (the default value is 10)

Sample Request

https://api.addsearch.com/v1/suggest/1bed1ffde465fddba2a53ad3ce69e6c2?term=api

Response

{
  "suggestions": [
    {"value":"api"},
    {"value":"api call"},
    {"value":"rest api"},
    {"value":"search api"}
  ]
}

Please note that the Search Suggestions API endpoint does not require authentication.

The default rate limit for the Suggestions API is 5 requests/sec from a single IP address. A 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.