# PriceRunner Search API Documentation

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.

- **Documentation:** [https://scrappa.co/docs/pricerunner-api/pricerunner_search](https://scrappa.co/docs/pricerunner-api/pricerunner_search)
- **API group:** PriceRunner API
- **Endpoint:** `GET https://scrappa.co/api/pricerunner/search`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `q` | string | Yes | Search keyword, e.g. iphone. |
| `size` | integer | No | Results per page, 1 to 48. Defaults to 20. |
| `offset` | integer | No | 1-based result offset. Omit for the first page. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | One or more query parameters failed validation. |
| 503 | Upstream Unavailable | The public source is temporarily unavailable through every approved route. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
