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

SNIPES Search API Documentation

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

SNIPES Search API searches the SNIPES catalog or browses a category with a query or a category id. Each product carries numeric prices with currency (current, original, discount percent and amount), full size image URLs, and every size with an integer stock quantity. Facets carry the numeric ids that the size, color and brand filters take, and sorts carries the accepted sort codes.

Cost: 1 credit per request. Failed requests are not billed. The locale de is the only soaked store today; another locale answers 422. A price filter, an unknown sort, a perPage above 48 and a non-numeric facet id are refused with 422. Results never carry another page or another filter than the one requested.

SNIPES Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/snipes/search
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "data": {
        "sorts": [],
        "facets": [],
        "locale": "de",
        "currency": "EUR",
        "products": [
            {
                "id": "24853",
                "name": "AIR FORCE 1 07",
                "brand": {
                    "id": null,
                    "name": "Nike"
                },
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

10 optional filters available.

query string Optional

Search text, 2 to 100 characters. Send query or category, not both.

Example value coffee shops
category integer Optional

Numeric category id from the categories endpoint or a SNIPES category URL. Send query or category, not both.

Example value 10
locale string Optional

Store locale. Only de is soaked.

Example value en-US
page integer Optional

One-based page number, default 1.

Example value 1
perPage integer Optional

12, 24 or 48 products per page, default 24.

Example value 10
sort string Optional

default, newest, price_asc, price_desc or reduction.

Example value relevance
size string Optional

Numeric size facet ids, comma separated.

Example value example
color string Optional

Numeric color facet ids, comma separated.

Example value example
brand string Optional

Numeric brand facet ids, comma separated.

Example value example
sale boolean Optional

true to return only reduced items.

Example value true

Response Schema

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

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "sorts": [],
        "facets": [],
        "locale": "de",
        "currency": "EUR",
        "products": [
            {
                "id": "24853",
                "name": "AIR FORCE 1 07",
                "brand": {
                    "id": null,
                    "name": "Nike"
                },
                "price": {
                    "current": 71.99,
                    "on_sale": true,
                    "currency": "EUR",
                    "original": 89.99,
                    "discount_amount": 18,
                    "discount_percent": 20
                },
                "sizes": [
                    {
                        "size": "42",
                        "stock": 3,
                        "in_stock": true
                    }
                ]
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 24,
            "total_pages": 48,
            "has_next_page": true,
            "total_results": 1142
        },
        "breadcrumbs": []
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A parameter is missing or invalid, the locale is not soaked, or the answer did not match the request. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "The request cannot be served as sent."
    },
    "success": false
}
503

Upstream Unavailable

SNIPES could not be reached. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "SNIPES could not be reached. Please retry shortly."
    },
    "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.