# Tmall Search API Documentation

<p>Search the public logged-out Tmall catalogue. Tmall rows are split from the shop-name badge in the same response and marked with is_tmall. Each result carries the item id string for the item endpoint, a CNY price with original price, shop, location, full-size images and tags. The public page serves one result page only. Page values above 1 are rejected. Failed requests are never charged.</p>

- **Documentation:** [https://scrappa.co/docs/tmall-api/tmall_search](https://scrappa.co/docs/tmall-api/tmall_search)
- **API group:** Tmall API
- **Endpoint:** `GET https://scrappa.co/api/tmall/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 | Yes | Search words. |
| `page` | integer | No | Only page 1 is available. |
| `sort` | string | No | default, price_asc or price_desc. |
| `site` | string | No | Storefront: world, sg, my, th, jp or ca. |

## Example response

```json
{
    "data": {
        "count": 1,
        "results": [
            {
                "price": {
                    "amount": 2999,
                    "currency": "CNY"
                },
                "title": "Example brand product",
                "is_tmall": true,
                "item_id_str": "TOKEN"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "tmall_search"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is invalid. 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)
