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.
- **Documentation:** [https://scrappa.co/docs/about-you-api/about_you_search](https://scrappa.co/docs/about-you-api/about_you_search) - **API group:** ABOUT YOU API - **Endpoint:** `GET https://scrappa.co/api/about-you/search` ## 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 | | --- | --- | --- | --- | | `query` | string | No | 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. | | `category` | integer | No | Category id such as 20202 (men) or 20201 (women). Ids are part of the category links in product answers. Send category or query. | | `brand` | string | No | Brand ids separated by commas, from include_facets or from the brand of an item. Names are accepted with resolve_names=true. | | `color` | string | No | Color ids separated by commas, from include_facets. Names are accepted with resolve_names=true. | | `size` | string | No | Size ids separated by commas, from include_facets. Needs size_system. | | `size_system` | string | No | Size system key from include_facets, for example defMaleInt. Needs size. | | `min_price` | number | No | Minimum price in the currency of the shop, for example 20. | | `max_price` | number | No | Maximum price in the currency of the shop, for example 40. | | `sale_only` | boolean | No | true returns only reduced products. | | `sort` | string | No | top_seller (default), highest_reduction, price_desc, price_asc or newest. | | `page` | integer | No | One-based page number, 1 to 1000 (default 1). | | `limit` | integer | No | Products per page, 1 to 50 (default 30). A page can hold a few products less than the limit. | | `include_facets` | boolean | No | true adds the total count and the filter options: brands, colors, price range and size systems. Costs 2 credits. | | `resolve_names` | boolean | No | true accepts brand and color names in brand and color. Costs 2 credits. | | `country` | string | No | Shop: de (default), ch, at, nl, be, pl, cz, sk, ro, hu, fr or lu. Product ids and categories can differ per shop. | | `language` | string | No | Optional. ch takes de (default) or fr. be takes fr (default) or nl. Other shops have one language. | ## Example response ```json { "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 | Status | Error | Description | | --- | --- | --- | | 422 | Validation Error | A parameter is missing or invalid. This response is not billable. | | 404 | Not Found | The category does not exist in this shop. This response is not billable. | | 503 | Upstream Unavailable | ABOUT YOU could not be reached. Retry shortly. This response is not billable. | ## 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)