Autocomplete
GET /request
When making a request with the type parameter set to type=autocomplete Rainforest API will return autocomplete suggestions for the search term specified in the search_term parameter, on the Amazon domain specified in the amazon_domain parameter.
You may scope your autocomplete request to an Amazon autocomplete alias (synonymous with a product area or top-level category) by specifying the alias using the autocomplete_alias parameter. The available autocomplete_alias values vary depending on the amazon_domain used. You can find a full list of all autocomplete aliaes, per Amazon-domain, in the autocomplete aliases reference.
For example, to request autocomplete suggestions for the search term animal on amazon.com using the autocomplete alias "Books" the request would be:
The following parameters are available for all requests made when type=autocomplete .
Parameter | Required | Description |
|---|---|---|
amazon_domain | required | The Amazon domain to retrieve autocomplete details from for the search term specified in the search_term parameter. For a full list of supported Amazon domains see Supported Amazon Domains . |
search_term | required | The search term to get autocomplete suggestions for. Used in combination with the amazon_domain parameter. |
autocomplete_alias | optional | The alias to use to scope the autocomplete request. Autocomplete aliases can be thought of as the "category" area that the autocomplete request runs in. If none is specified then Rainforest will default to running the autocomplete request in the top-level "All Departments" autocomplete alias. For a full list of supported Autocomplete Aliases see Supported Autocomplete Aliases . |
Next Steps Autocomplete Results