GET /api/pricespy/autocomplete returns product ids, names, prices, image URLs and category filter ids from a keyword. Use an id with the product and price-history endpoints.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
string
Required
Search keyword, e.g. iphone.
iphone
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
meta
success
suggestions
Common suggestions fields
id
name
price
category_id
{
"meta": {
"attempts": 1,
"billable": true
},
"success": true,
"suggestions": [
{
"id": "12345",
"name": "Apple iPhone",
"price": {
"value": 699,
"currency": "GBP"
},
"category_id": "42"
}
]
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
One or more query parameters failed validation.
{
"errors": {
"q": [
"The q field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
The public source is temporarily unavailable through every approved route.
{
"meta": {
"billable": false,
"retryable": true
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "PriceSpy data is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.