GET /api/pricerunner/similar returns similar product cards for a category and product id from search.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
2 required parameters needed before sending a request.
1 optional filter available.
string
Required
Category id from navigation or search.
1
string
Required
Product id from suggest or search.
12345678
integer
Optional
Number of similar products, 1 to 48. Defaults to 12.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
meta
success
products
{
"meta": {
"attempts": 1,
"billable": true
},
"success": true,
"products": []
}
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": "PriceRunner 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.