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

SHEIN Keywords API Documentation

GET https://scrappa.co/api/shein/keywords?region=de&word_type=2

Returns the public keyword list of one SHEIN storefront plus the goods ids carried in its ranking board. Board goods carry their name and a full-size image. Keyword rows may have no id; use any id from goods or goods_ids unchanged with the product endpoint. Region is an id set: de, uk and il each return their own ids; a foreign id is rejected by the detail endpoint. When the board is empty the id source retries once on another exit and the answer stays non-billable. No keyword goods listing is available. Failed, gated and empty lookups are not billed. Every successful route costs 1 credit. Clients are never rate limited.

SHEIN Keywords API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/shein/keywords?region=de&word_type=2
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "success": true,
    "data": {
        "region": "de",
        "word_type": "2",
        "currency": "EUR",
        "keywords": [
            {
                "word": "Party Dresses For Women",
                "word_id": "12326452",
                "goods_id": null,
                "page_id": null,
                "page_type": null,
                "page_url": null,
...

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.

2 optional filters available.

region string Optional

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

Example value de
word_type string Optional

2 for trending keywords, 1 for the home set. Default: 2.

Example value 2

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/shein/keywords?region=de&word_type=2",
    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/keywords?region=de&word_type=2');

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/keywords?region=de&word_type=2', 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/keywords?region=de&word_type=2',
    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/keywords?region=de&word_type=2")
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/keywords?region=de&word_type=2", 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/keywords?region=de&word_type=2', 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/keywords?region=de&word_type=2")
        .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/keywords?region=de&word_type=2", 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/keywords?region=de&word_type=2"
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/keywords?region=de&word_type=2"));
            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/keywords?region=de&word_type=2',
            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/keywords?region=de&word_type=2")
        .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",
        "word_type": "2",
        "currency": "EUR",
        "keywords": [
            {
                "word": "Party Dresses For Women",
                "word_id": "12326452",
                "goods_id": null,
                "page_id": null,
                "page_type": null,
                "page_url": null,
                "route_url": null,
                "category_ids": []
            }
        ],
        "goods": [
            {
                "goods_id": "555717711",
                "name": "640pcs DIY Faux Mink Eyelash Clusters, D Curl, Voluminous And Fluffy, 8-16mm Mixed Length, Suitable For All Makeup Looks. Glue, Remover, Tweezers Available Based On Need. Lightweight, Reusable And Cost-Effective, Suitable For Beginners, Applicable To Various Occasions, Beautiful",
                "image": "https://img.ltwebstatic.com/v4/j/spmp/2026/09/01/79/1788226764d53958846db078698d1ceaea81741f5b.jpg"
            }
        ],
        "goods_ids": [
            "555717711"
        ],
        "total": 1,
        "goods_total": 1
    },
    "meta": {
        "endpoint_family": "keywords",
        "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.