# SHEIN Filters API Documentation

Returns the public category and attribute facets of one SHEIN storefront for the given keywords. Categories carry their own ids and children, and the response also carries attribute groups and tags. The tree is capped at two levels and twelve children per node to keep the body small; category_count remains the full top-level count. Facet ids come from the same storefront as the region. The goods listing behind the facets is not available. Failed, gated and empty lookups are not billed. Every successful route costs 1 credit. Clients are never rate limited.

- **Documentation:** [https://scrappa.co/docs/shein-api/shein_filters](https://scrappa.co/docs/shein-api/shein_filters)
- **API group:** SHEIN API
- **Endpoint:** `GET https://scrappa.co/api/shein/filters`

## 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 |
| --- | --- | --- | --- |
| `keywords` | string | Yes | Facet keywords, for example dress. |
| `region` | string | No | Storefront: de, uk or il. Default: de. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/shein/filters?keywords=dress&region=de"
```

## Example response

```json
{
    "success": true,
    "data": {
        "region": "de",
        "keywords": "dress",
        "currency": "EUR",
        "categories": [
            {
                "id": "4436",
                "name": "Women Apparel",
                "children": [
                    {
                        "id": "2030",
                        "name": "Women Clothing",
                        "children": [
                            {
                                "id": "12472",
                                "name": "Women Dresses",
                                "children": []
                            },
                            {
                                "id": "2216",
                                "name": "Women Knitwear",
                                "children": []
                            },
                            {
                                "id": "2040",
                                "name": "Women Co-ords",
                                "children": []
                            },
                            {
                                "id": "2039",
                                "name": "Women Beachwear",
                                "children": []
                            },
                            {
                                "id": "2036",
                                "name": "Women Suits",
                                "children": []
                            },
                            {
                                "id": "1766",
                                "name": "Women Tops, Blouses & Tee",
                                "children": []
                            },
                            {
                                "id": "3287",
                                "name": "Women Jumpsuits & Bodysuits",
                                "children": []
                            },
                            {
                                "id": "2037",
                                "name": "Women Outerwear",
                                "children": []
                            },
                            {
                                "id": "1767",
                                "name": "Women Bottoms",
                                "children": []
                            },
                            {
                                "id": "1930",
                                "name": "Women Denim",
                                "children": []
                            },
                            {
                                "id": "1773",
                                "name": "Women Sweatshirts & Hoodies",
                                "children": []
                            }
                        ]
                    },
                    {
                        "id": "1888",
                        "name": "Women Plus Clothing",
                        "children": [
                            {
                                "id": "1889",
                                "name": "Plus Size Dresses",
                                "children": []
                            },
                            {
                                "id": "1928",
                                "name": "Plus Size Co-Ords",
                                "children": []
                            },
                            {
                                "id": "2056",
                                "name": "Plus Size Sweatshirts & Hoodies",
                                "children": []
                            },
                            {
                                "id": "2225",
                                "name": "Plus Size Tops",
                                "children": []
                            },
                            {
                                "id": "2226",
                                "name": "Plus Size Bottoms",
                                "children": []
                            },
                            {
                                "id": "2227",
                                "name": "Plus Size Knitwear",
                                "children": []
                            },
                            {
                                "id": "2248",
                                "name": "Plus Size Denim",
                                "children": []
                            },
                            {
                                "id": "2249",
                                "name": "Plus Size Outerwears",
                                "children": []
                            },
                            {
                                "id": "3611",
                                "name": "Plus Size Jumpsuits & Bodysuits",
                                "children": []
                            },
                            {
                                "id": "3612",
                                "name": "Plus Size Suits",
                                "children": []
                            },
                            {
                                "id": "3613",
                                "name": "Women Plus Beachwear",
                                "children": []
                            }
                        ]
                    },
                    {
                        "id": "3088",
                        "name": "Weddings & Events",
                        "children": [
                            {
                                "id": "5360",
                                "name": "Women Party Wear",
                                "children": []
                            },
                            {
                                "id": "3090",
                                "name": "Women Wedding",
                                "children": []
                            },
                            {
                                "id": "3734",
                                "name": "Women Plus Wedding",
                                "children": []
                            },
                            {
                                "id": "5363",
                                "name": "Women Plus Party Wear",
                                "children": []
                            }
                        ]
                    }
                ]
            }
        ],
        "attributes": [],
        "tags": [],
        "category_count": 19,
        "attribute_count": 0
    },
    "meta": {
        "endpoint_family": "filters",
        "billable": true,
        "source": "shein",
        "currency": "EUR",
        "credits": 1,
        "cached": false
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A region, id or keyword is missing or invalid. Non-billable. |
| 503 | Upstream Unavailable | The storefront could not be reached or answered with a challenge. Retry later. Non-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)
