Skip to content
Scrappa Get API key
ABOUT YOU API 1-3 credits / request

ABOUT YOU Search API Documentation

GET https://scrappa.co/api/about-you/search

ABOUT YOU Search API lists products of a category, a brand or a keyword with sale, price, brand, color and size filters, five sort orders and paging. Each item has id, name, brand, link, images, price with original price and discount, size labels, color variants and badges. Open Product Details for the stock per size.

Filters are always honoured: the answer never holds a product that breaks a requested filter. Page N is the real page N.

A keyword that names a category or brand (for example jeans or nike) works like the category route. Any other keyword is a free text search: it returns page 1 in default order and answers 422 when a filter, a sort or a page above 1 is sent.

Credits: 1 credit per successful request with results. include_facets=true or resolve_names=true read the filter options as well and cost 2 credits, both together cost 3. Failed requests and empty searches are not billed.

ABOUT YOU Search API Documentation 1-3 credits / request

Endpoint

Request preview
GET
https://scrappa.co/api/about-you/search
Auth header
x-api-key
Cost
1-3 credits / request
Response preview
200 OK
{
    "data": {
        "page": 1,
        "sort": "highest_reduction",
        "count": 2,
        "items": [
            {
                "id": 28330092,
                "url": "https://www.aboutyou.de/p/yazubi/hose-kyle-28330092",
                "name": "Slimfit Hose 'Kyle'",
                "brand": {
                    "id": 155736,
                    "name": "yazubi"
                },
...

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.

16 optional filters available.

query string Optional

Keyword such as jeans or nike. A term that names a category or brand supports every filter. Any other term returns page 1 in default order and answers 422 when a filter, a sort or page 2 is sent. Send query or category.

Example value coffee shops
category integer Optional

Category id such as 20202 (men) or 20201 (women). Ids are part of the category links in product answers. Send category or query.

Example value 10
brand string Optional

Brand ids separated by commas, from include_facets or from the brand of an item. Names are accepted with resolve_names=true.

Example value example
color string Optional

Color ids separated by commas, from include_facets. Names are accepted with resolve_names=true.

Example value example
size string Optional

Size ids separated by commas, from include_facets. Needs size_system.

Example value example
size_system string Optional

Size system key from include_facets, for example defMaleInt. Needs size.

Example value example
min_price number Optional

Minimum price in the currency of the shop, for example 20.

Example value 10
max_price number Optional

Maximum price in the currency of the shop, for example 40.

Example value 10
sale_only boolean Optional

true returns only reduced products.

Example value true
sort string Optional

top_seller (default), highest_reduction, price_desc, price_asc or newest.

Example value relevance
page integer Optional

One-based page number, 1 to 1000 (default 1).

Example value 1
limit integer Optional

Products per page, 1 to 50 (default 30). A page can hold a few products less than the limit.

Example value 10
include_facets boolean Optional

true adds the total count and the filter options: brands, colors, price range and size systems. Costs 2 credits.

Example value true
resolve_names boolean Optional

true accepts brand and color names in brand and color. Costs 2 credits.

Example value true
country string Optional

Shop: de (default), ch, at, nl, be, pl, cz, sk, ro, hu, fr or lu. Product ids and categories can differ per shop.

Example value US
language string Optional

Optional. ch takes de (default) or fr. be takes fr (default) or nl. Other shops have one language.

Example value en

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": {
        "page": 1,
        "sort": "highest_reduction",
        "count": 2,
        "items": [
            {
                "id": 28330092,
                "url": "https://www.aboutyou.de/p/yazubi/hose-kyle-28330092",
                "name": "Slimfit Hose 'Kyle'",
                "brand": {
                    "id": 155736,
                    "name": "yazubi"
                },
                "image": "https://cdn.aboutstatic.com/file/images/20e17c6cf15f066913e4b84095c71339.jpeg",
                "price": {
                    "net": 37.73,
                    "current": 49.9,
                    "currency": "EUR",
                    "original": 79.95,
                    "discount_amount": 30.05,
                    "discount_percent": 37,
                    "price_with_coupon": 44.91
                },
                "sizes": [
                    "29 x 34",
                    "29 x 32",
                    "29 x 30",
                    "30 x 32"
                ],
                "badges": [
                    "-37%"
                ],
                "images": [
                    "https://cdn.aboutstatic.com/file/images/20e17c6cf15f066913e4b84095c71339.jpeg",
                    "https://cdn.aboutstatic.com/file/images/b5f199b7d3a4860d54e6d4f78348a1d9.jpeg?brightness=0.96&trim=1"
                ],
                "on_sale": true,
                "sponsored": true,
                "coupon_label": "-10% COUPON",
                "color_variants": [
                    {
                        "hex": "#D2CFC7",
                        "product_id": 28330092
                    },
                    {
                        "hex": "#3E3F41",
                        "product_id": 28329947
                    }
                ],
                "price_reference": {
                    "label": "Letzter niedrigster Preis",
                    "amount": 39.92
                }
            },
            {
                "id": 32314559,
                "url": "https://www.aboutyou.de/p/almbock/trachtenhose-trachtenlederhose-kurz-leo-dunkelbraun-32314559",
                "name": "Skinny Trachtenhose 'Trachtenlederhose kurz Leo dunkelbraun'\u200c\u200c\u200c\u200c\u200c\u200c",
                "brand": {
                    "id": 114871,
                    "name": "Almbock"
                },
                "image": "https://cdn.aboutstatic.com/file/images/123f54a2ab4fe41736c3bd4bd233c27f.jpeg?brightness=0.96&trim=1",
                "price": {
                    "net": 83.95,
                    "current": 99.9,
                    "currency": "EUR",
                    "original": 119.9,
                    "discount_amount": 20,
                    "discount_percent": 16,
                    "price_with_coupon": null
                },
                "sizes": [
                    "46",
                    "48",
                    "50",
                    "52"
                ],
                "badges": [
                    "-16%"
                ],
                "images": [
                    "https://cdn.aboutstatic.com/file/images/123f54a2ab4fe41736c3bd4bd233c27f.jpeg?brightness=0.96&trim=1",
                    "https://cdn.aboutstatic.com/file/images/c7186ce379626e837be245e30fae0270.jpeg?brightness=0.96&trim=1"
                ],
                "on_sale": true,
                "sponsored": true,
                "coupon_label": "-16%",
                "color_variants": [
                    {
                        "hex": "#4c2002",
                        "product_id": 32314559
                    }
                ],
                "price_reference": {
                    "label": "Letzter niedrigster Preis",
                    "amount": 89.91
                }
            }
        ],
        "limit": 30,
        "total": null,
        "country": "de",
        "has_more": true,
        "language": "de",
        "category_id": 20202,
        "resolved_as": "category"
    },
    "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. This response is not billable.

{
    "errors": {
        "country": [
            "The country must be one of: de, ch, at, nl, be, pl, cz, sk, ro, hu, fr, lu."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The category does not exist in this shop. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

ABOUT YOU could not be reached. Retry shortly. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "ABOUT YOU 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.