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

PriceRunner Search API Documentation

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

GET /api/pricerunner/search returns products with numeric prices and currency, ratings, images and a total. Use offset for deeper pages; offset=0 is never forwarded upstream.

PriceRunner Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/pricerunner/search
Auth header
x-api-key
Cost
1 credit / request
q = iphone
Response preview
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "total": 120,
    "success": true,
    "products": [
        {
            "id": "12345678",
            "name": "Apple iPhone",
            "image": "https://www.pricerunner.com/image.jpg",
            "rating": 4.5,
            "lowest_price": {
...

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.

2 optional filters available.

q string Required

Search keyword, e.g. iphone.

Example value iphone
size integer Optional

Results per page, 1 to 48. Defaults to 20.

Example value 20
offset integer Optional

1-based result offset. Omit for the first page.

Example value 10

Response Schema

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

Example response fields

Scan these fields before integrating.

meta total success products

Common products fields

id name image rating
JSON Response
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "total": 120,
    "success": true,
    "products": [
        {
            "id": "12345678",
            "name": "Apple iPhone",
            "image": "https://www.pricerunner.com/image.jpg",
            "rating": 4.5,
            "lowest_price": {
                "value": 699,
                "currency": "GBP"
            }
        }
    ]
}

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.