# PriceRunner Suggest API Documentation

GET /api/pricerunner/suggest returns product ids, names and images from a keyword. Use an id with the offers, price-history, reviews, detail and product-info endpoints.

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

## 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. |

## Example response

```json
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "success": true,
    "suggestions": [
        {
            "id": "12345678",
            "name": "Apple iPhone",
            "image": "https://www.pricerunner.com/image.jpg",
            "category": "Mobiles"
        }
    ]
}
```

## 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)
