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

Taobao Search API Documentation

GET https://scrappa.co/api/taobao/search

Search the public logged-out Taobao catalogue. Each result carries the item id string for the item endpoint, the numeric shop id for the shop endpoint, a CNY price with original price and discount label, shop and seller, ships-from location, category path, full-size images and tags. The public page serves one result page only: page values above 1 are rejected. Price filters are applied to the returned rows and sort can reorder them by price. Autocomplete keywords are a separate endpoint, not product ids. Failed requests are never charged.

Taobao Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/taobao/search
Auth header
x-api-key
Cost
1 credit / request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "page": 1,
        "count": 1,
        "query": "phone",
        "results": [
            {
                "shop": {
                    "id": "107922698",
                    "name": "Example shop"
                },
                "price": {
                    "amount": 1999,
                    "currency": "CNY",
...

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.

5 optional filters available.

query string Required

Search words, e.g. phone.

Example value coffee shops
page integer Optional

Only page 1 is available; higher values are rejected.

Example value 1
sort string Optional

default, price_asc or price_desc; applied to the returned page.

Example value relevance
min_price number Optional

Lowest CNY price kept from the returned page.

Example value 10
max_price number Optional

Highest CNY price kept from the returned page.

Example value 10
site string Optional

Storefront: world, sg, my, th, jp or ca.

Example value example

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,
        "count": 1,
        "query": "phone",
        "results": [
            {
                "shop": {
                    "id": "107922698",
                    "name": "Example shop"
                },
                "price": {
                    "amount": 1999,
                    "currency": "CNY",
                    "original": 2499,
                    "discount_label": "20% off"
                },
                "title": "Example phone",
                "images": [
                    "https://img.alicdn.com/example.jpg"
                ],
                "is_tmall": false,
                "item_id_str": "NnA1ek1CdXZMRTBpaEE4WUpxeUtnQT09"
            }
        ],
        "has_more": false
    },
    "meta": {
        "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 invalid. Not billable.

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

Service Unavailable

The catalogue is temporarily unavailable. Not billable.

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