Skip to content
Scrappa Get API key
PriceRunner API 1 credit / request

PriceRunner Similar Products API Documentation

GET https://scrappa.co/api/pricerunner/similar

GET /api/pricerunner/similar returns similar product cards for a category and product id from search.

PriceRunner Similar Products API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/pricerunner/similar
Auth header
x-api-key
Cost
1 credit / request
cat = 1 id = 12345678
Response preview
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "success": true,
    "products": []
}

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.

cat string Required

Category id from navigation or search.

Example value 1
id string Required

Product id from suggest or search.

Example value 12345678
size integer Optional

Number of similar products, 1 to 48. Defaults to 12.

Example value 10

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

meta success products
JSON Response
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "success": true,
    "products": []
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

One or more query parameters failed validation.

{
    "errors": {
        "q": [
            "The q field is required."
        ]
    },
    "message": "The request validation failed"
}
503

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.