> ## 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 Shopee product search

> Searches a Shopee market (Singapore, Indonesia, Malaysia, Thailand, Vietnam, Philippines, Taiwan or Brazil - `country`) for `q` and returns one page of results: up to 40 `products`, each with `position`, `itemId`, `shopId`, `name`, `url`, `image`, `price`, `originalPrice` (when Shopee shows the crossed-out price), `discountPercent`, `currency`, `rating` (average stars), `location` (where the seller ships from) and `labels` (promotion badges). `sort` orders the results, `min_price` / `max_price` filter them, `shop_id` keeps one shop's products (or lists the shop without `q`), and `url` takes a Shopee search or category link instead. Shopee shows one page per search, so run several sort orders or price ranges for more products. `price` is what Shopee shows a signed-out shopper, which can be a promotional or new-customer price (see `labels`). Not available: stock, units sold, rating counts and reviews (Shopee does not publish them on the pages these endpoints read). One unit per call.



## OpenAPI

````yaml /api-reference/openapi.json post /marketplace/shopee-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/shopee-search:
    post:
      tags:
        - Plugins
      summary: Scrape Shopee product search
      description: >-
        Searches a Shopee market (Singapore, Indonesia, Malaysia, Thailand,
        Vietnam, Philippines, Taiwan or Brazil - `country`) for `q` and returns
        one page of results: up to 40 `products`, each with `position`,
        `itemId`, `shopId`, `name`, `url`, `image`, `price`, `originalPrice`
        (when Shopee shows the crossed-out price), `discountPercent`,
        `currency`, `rating` (average stars), `location` (where the seller ships
        from) and `labels` (promotion badges). `sort` orders the results,
        `min_price` / `max_price` filter them, `shop_id` keeps one shop's
        products (or lists the shop without `q`), and `url` takes a Shopee
        search or category link instead. Shopee shows one page per search, so
        run several sort orders or price ranges for more products. `price` is
        what Shopee shows a signed-out shopper, which can be a promotional or
        new-customer price (see `labels`). Not available: stock, units sold,
        rating counts and reviews (Shopee does not publish them on the pages
        these endpoints read). One unit per call.
      operationId: shopee_search_marketplace_shopee_search_post
      parameters:
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              What to search for, e.g. 'iphone case' or 'air fryer'. Optional
              with `shop_id`.
            title: Q
          description: >-
            What to search for, e.g. 'iphone case' or 'air fryer'. Optional with
            `shop_id`.
        - name: country
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Shopee market: 'sg' (shopee.sg), 'id' (shopee.co.id), 'my'
              (shopee.com.my), 'th' (shopee.co.th), 'vn' (shopee.vn), 'ph'
              (shopee.ph), 'tw' (shopee.tw), 'br' (shopee.com.br). Default 'sg'.
              Prices are in that market's currency.
            title: Country
          description: >-
            Shopee market: 'sg' (shopee.sg), 'id' (shopee.co.id), 'my'
            (shopee.com.my), 'th' (shopee.co.th), 'vn' (shopee.vn), 'ph'
            (shopee.ph), 'tw' (shopee.tw), 'br' (shopee.com.br). Default 'sg'.
            Prices are in that market's currency.
        - name: shop_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Only this shop's products (the number in a shop's links, e.g.
              442800909). Without `q` it lists the shop.
            title: Shop Id
          description: >-
            Only this shop's products (the number in a shop's links, e.g.
            442800909). Without `q` it lists the shop.
        - name: url
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              A Shopee search or category link (e.g.
              https://shopee.sg/search?keyword=lego or
              https://shopee.sg/Cases-Covers-cat.11013350.11013434.11027839),
              used as it is; `q`, `country`, `shop_id`, `sort` and the price
              filters are then ignored.
            title: Url
          description: >-
            A Shopee search or category link (e.g.
            https://shopee.sg/search?keyword=lego or
            https://shopee.sg/Cases-Covers-cat.11013350.11013434.11027839), used
            as it is; `q`, `country`, `shop_id`, `sort` and the price filters
            are then ignored.
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: 'Result order: relevance, sales, newest, price_asc, price_desc.'
            default: relevance
            title: Sort
          description: 'Result order: relevance, sales, newest, price_asc, price_desc.'
        - name: min_price
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Lowest price, in the market's currency.
            title: Min Price
          description: Lowest price, in the market's currency.
        - name: max_price
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Highest price, in the market's currency.
            title: Max Price
          description: Highest price, in the market's currency.
        - name: max_results
          in: query
          required: false
          schema:
            type: integer
            description: Products to return, 1-40 (one Shopee results page).
            default: 40
            title: Max Results
          description: Products to return, 1-40 (one Shopee results page).
      responses:
        '200':
          description: JSON with a `products` array.
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid parameters.
        '404':
          description: Shopee found no products for this search.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: >-
            Blocked by Shopee on every attempt, an unusable answer, or no answer
            in time.
      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.