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

PriceSpy Autocomplete API Documentation

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

GET /api/pricespy/autocomplete returns product ids, names, prices, image URLs and category filter ids from a keyword. Use an id with the product and price-history endpoints.

PriceSpy Autocomplete API Documentation 1 credit / request

Endpoint

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

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.

q string Required

Search keyword, e.g. iphone.

Example value iphone

Response Schema

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

Example response fields

Scan these fields before integrating.

meta success suggestions

Common suggestions fields

id name price category_id
JSON Response
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "success": true,
    "suggestions": [
        {
            "id": "12345",
            "name": "Apple iPhone",
            "price": {
                "value": 699,
                "currency": "GBP"
            },
            "category_id": "42"
        }
    ]
}

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.