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

PriceSpy Search API Documentation

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

GET /api/pricespy/search returns product cards with numeric prices and images. Add a category id from the categories endpoint to get category-scoped products. Only the first upstream result page is returned. There is no page or offset parameter.

PriceSpy Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/pricespy/search
Auth header
x-api-key
Cost
1 credit / request
q = iphone
Response preview
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "page": 1,
    "total": 240,
    "success": true,
    "products": [
        {
            "id": "12345",
            "name": "Apple iPhone",
            "price": {
                "value": 699,
...

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.

1 optional filter available.

q string Required

Search keyword, e.g. iphone.

Example value iphone
category string Optional

Category id from the categories endpoint.

Example value example

Response Schema

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

Example response fields

Scan these fields before integrating.

meta page total success products pagination

Common products fields

id name price
JSON Response
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "page": 1,
    "total": 240,
    "success": true,
    "products": [
        {
            "id": "12345",
            "name": "Apple iPhone",
            "price": {
                "value": 699,
                "currency": "GBP"
            }
        }
    ],
    "pagination": {
        "note": "First result page only.",
        "page": 1,
        "has_more": false
    }
}

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": "PriceSpy 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.