↑ ↓ to move ↵ to open
Amazon Commerce API reference

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
POST /execute
Run an endpoint
MCP tool when pinned
amazon__search__suggestions
Pin tools
OpenAPI
openapi.json
Download

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

Input

FieldTypeRequiredWhat it doesExample
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:

results[0].data
{  "suggestions": [    {      "type": "KeywordSuggestion",      "value": "wireless mouse"    },    {      "type": "KeywordSuggestion",      "value": "wireless keyboard and mouse"    }  ]}

Fields

FieldTypeWhat it isExample
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.