Amazon Search Suggestions
amazon.search.suggestions
Get Amazon's search suggestions for the start of a query, the way the search box completes it.
At a glance
- Endpoint ID
amazon.search.suggestions- Price
- 1 credit per call; failed calls are free
- Runs for up to
- 30 seconds
Request
Send the endpoint ID as capability and its fields as input. Set UPSCRAPE_API_KEY to your key first.
curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "capability": "amazon.search.suggestions", "input": { "limit": 5, "prefix": "wireless" }}'
import jsonimport osimport requestspayload = json.loads(r'''{ "capability": "amazon.search.suggestions", "input": { "limit": 5, "prefix": "wireless" }}''')response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload,)response.raise_for_status()print(json.dumps(response.json(), indent=2))
const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`, "Content-Type": "application/json", "Prefer": "wait=30", }, body: JSON.stringify({ "capability": "amazon.search.suggestions", "input": { "limit": 5, "prefix": "wireless" }}),});if (!response.ok) { throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));
Input
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
prefix |
string | yes | wireless | |
limit |
integer | no | Maximum number of results to return. From 1 to 20. | 5 |
Response
A finished call answers with HTTP 200; the data is in results[0].data, and billing.credits_charged is what it cost. A call still running after the wait answers 202: see jobs and results.
This is results[0].data from a real run:
{ "suggestions": [ { "type": "KeywordSuggestion", "value": "wireless mouse" }, { "type": "KeywordSuggestion", "value": "wireless keyboard and mouse" } ]}
Fields
| Field | Type | What it is | Example |
|---|---|---|---|
suggestions[].value |
string | The suggested search. | wireless mouse |
suggestions[].type |
string | The kind of suggestion. | KeywordSuggestion |
suggestions |
array | Search suggestions for what you typed. | 5 records |
If a call fails
A failed call costs nothing. The response carries an error.code you can branch on; Errors and retries lists every code and which ones to retry.
Other Amazon Commerce endpoints
Something missing or unclear? Ask the team that builds the Amazon Commerce endpoints.