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

SHEIN Filters API Documentation

GET https://scrappa.co/api/shein/filters?keywords=dress&region=de

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.

SHEIN Filters API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/shein/filters?keywords=dress&region=de
Auth header
x-api-key
Cost
1 credit / request
keywords = dress
Response preview
200 OK
{
    "success": true,
    "data": {
        "region": "de",
        "keywords": "dress",
        "currency": "EUR",
        "categories": [
            {
                "id": "4436",
                "name": "Women Apparel",
                "children": [
                    {
                        "id": "2030",
                        "name": "Women Clothing",
...

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.

1 optional filter available.

keywords string Required

Facet keywords, for example dress.

Example value dress
region string Optional

Storefront: de, uk or il. Default: de.

Example value de

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/shein/filters?keywords=dress&region=de",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/shein/filters?keywords=dress&region=de');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/shein/filters?keywords=dress&region=de', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/shein/filters?keywords=dress&region=de',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/shein/filters?keywords=dress&region=de")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/shein/filters?keywords=dress&region=de", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/shein/filters?keywords=dress&region=de', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/shein/filters?keywords=dress&region=de")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/shein/filters?keywords=dress&region=de", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/shein/filters?keywords=dress&region=de"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/shein/filters?keywords=dress&region=de"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/shein/filters?keywords=dress&region=de',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/shein/filters?keywords=dress&region=de")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

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

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "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

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

422

Validation Error

A region, id or keyword is missing or invalid. Non-billable.

{
    "message": "The request validation failed"
}
503

Upstream Unavailable

The storefront could not be reached or answered with a challenge. Retry later. Non-billable.

{
    "code": "upstream_unavailable",
    "meta": {
        "billable": false
    },
    "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.