> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapeunblocker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scrape Taobao / Tmall keyword or category listings

> Returns the products Taobao lists for a keyword `q` (or a `category`) as JSON: `products` (`position`, `itemId`, `title`, `url`, `image`, `price` in yuan with `currency` CNY, `priceLabel` (Taobao's price tag, e.g. 优惠价), `localPrices` (the same price in the storefront's currency, HKD and TWD), `shopId`, `shopName`, `descriptionMatchScore`, `freeShipping`, `categoryId`, `rootCategoryId`, `sellingPoints`, `reviewHighlights`), `totalResults` (how many listings Taobao reports), and `filterOptions` (brand and property facets; pass an option's `filter` value back as `filter`). Sort by relevance, sales or price and filter by a yuan price range (products whose listed price falls outside it are left out and counted in `droppedOutsidePriceRange`). Taobao shows signed-out visitors only the first 20 products of a list, so one call returns up to 20 (narrow with price ranges and filters to reach more). When Taobao has no list for the keyword, the call answers with the list of the closest keyword Taobao itself suggests and says so: `keywordSubstituted` true and `matchedKeyword`. Text comes in Chinese as sellers write it. Companion to `/marketplace/taobao-product`. One unit per call.



## OpenAPI

````yaml /api-reference/openapi.json post /marketplace/taobao-search
openapi: 3.1.0
info:
  title: ScrapeUnblocker API
  description: >-
    Public API for the ScrapeUnblocker proxy/anti-bot service. Authenticate
    every request with the `x-scrapeunblocker-key` header. Documented here:
    page-source extraction, Google SERP scraping, image fetch, and the dedicated
    plugin endpoints (search engines, marketplaces, reviews, travel, social and
    more). All other paths exist for internal operations and are intentionally
    hidden from this spec.
  version: 3.0.0
servers:
  - url: https://api.scrapeunblocker.com
    description: Production
security: []
paths:
  /marketplace/taobao-search:
    post:
      tags:
        - Plugins
      summary: Scrape Taobao / Tmall keyword or category listings
      description: >-
        Returns the products Taobao lists for a keyword `q` (or a `category`) as
        JSON: `products` (`position`, `itemId`, `title`, `url`, `image`, `price`
        in yuan with `currency` CNY, `priceLabel` (Taobao's price tag, e.g.
        优惠价), `localPrices` (the same price in the storefront's currency, HKD
        and TWD), `shopId`, `shopName`, `descriptionMatchScore`, `freeShipping`,
        `categoryId`, `rootCategoryId`, `sellingPoints`, `reviewHighlights`),
        `totalResults` (how many listings Taobao reports), and `filterOptions`
        (brand and property facets; pass an option's `filter` value back as
        `filter`). Sort by relevance, sales or price and filter by a yuan price
        range (products whose listed price falls outside it are left out and
        counted in `droppedOutsidePriceRange`). Taobao shows signed-out visitors
        only the first 20 products of a list, so one call returns up to 20
        (narrow with price ranges and filters to reach more). When Taobao has no
        list for the keyword, the call answers with the list of the closest
        keyword Taobao itself suggests and says so: `keywordSubstituted` true
        and `matchedKeyword`. Text comes in Chinese as sellers write it.
        Companion to `/marketplace/taobao-product`. One unit per call.
      operationId: taobao_search_marketplace_taobao_search_post
      parameters:
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Keyword, in Chinese or English, e.g. '手机壳', '连衣裙', 'phone case'
              (Chinese keywords match far more listings). A Taobao search or
              list link works too. Give `q` or `category`.
            title: Q
          description: >-
            Keyword, in Chinese or English, e.g. '手机壳', '连衣裙', 'phone case'
            (Chinese keywords match far more listings). A Taobao search or list
            link works too. Give `q` or `category`.
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              A Taobao category id, e.g. '50005050', or a category list link
              (https://www.taobao.com/list/category/50005050.htm). Returns the
              category's best sellers; sort and filters apply to keyword
              searches only.
            title: Category
          description: >-
            A Taobao category id, e.g. '50005050', or a category list link
            (https://www.taobao.com/list/category/50005050.htm). Returns the
            category's best sellers; sort and filters apply to keyword searches
            only.
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: 'Order: relevance, sales, price_asc, price_desc (price in yuan).'
            default: relevance
            title: Sort
          description: 'Order: relevance, sales, price_asc, price_desc (price in yuan).'
        - name: price_min
          in: query
          required: false
          schema:
            anyOf:
              - type: number
              - type: 'null'
            description: Only products at or above this many yuan (CNY).
            title: Price Min
          description: Only products at or above this many yuan (CNY).
        - name: price_max
          in: query
          required: false
          schema:
            anyOf:
              - type: number
              - type: 'null'
            description: Only products at or below this many yuan (CNY).
            title: Price Max
          description: Only products at or below this many yuan (CNY).
        - name: filter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              One brand or property filter, as the `filter` value of an option
              in `filterOptions` of an earlier answer, e.g. '20000-88634403'.
            title: Filter
          description: >-
            One brand or property filter, as the `filter` value of an option in
            `filterOptions` of an earlier answer, e.g. '20000-88634403'.
      responses:
        '200':
          description: JSON with a `products` array (up to 20).
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid parameters.
        '404':
          description: >-
            Taobao has no public list for the keyword (nor for any keyword it
            suggests instead), the category, or the filters; not billed.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: Taobao refused every attempt, or no answer in time; not billed.
      security:
        - ScrapeUnblockerKey: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ScrapeUnblockerKey:
      type: apiKey
      in: header
      name: x-scrapeunblocker-key
      description: Your ScrapeUnblocker API key. Apply on every request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.