# Shopee Scraper (`dtrungtin/shopee-scraper`) Actor A Puppeteer-based Apify Actor that scrapes product listings from [Shopee Vietnam](https://shopee.vn). Supports **search pages**, **category pages**, and automatically paginates through results up to a configurable item limit. - **URL**: https://apify.com/dtrungtin/shopee-scraper.md - **Developed by:** [Tin](https://apify.com/dtrungtin) (community) - **Categories:** E-commerce - **Stats:** 5 total users, 4 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing $10.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Shopee Scraper A Puppeteer-based Apify Actor that scrapes product listings from [Shopee Vietnam](https://shopee.vn). Supports **search pages**, **category pages**, and automatically paginates through results up to a configurable item limit. --- ### Features - Scrapes search results (`/search?keyword=...`) and category pages (`/category/...`) - Handles both Shopee API response shapes: - `/api/v4/search/search_items` — keyword search - `/api/v4/recommend/recommend_v2` — category landing pages - Automatic pagination via next-page URL detection (no click simulation) - Respects a `maxItems` limit and stops crawling once reached - Cookie-based login support for authenticated scraping - Prices normalised from Shopee micros (÷ 1,000,000) to real values - Full CDN image URLs constructed automatically --- ### Input | Field | Type | Default | Description | |---|---|---|---| | `startUrls` | array | `[{ url: "https://shopee.vn/Men-Clothes-cat.11035567" }]` | URLs to start scraping from (search or category pages) | | `maxItems` | integer | `10` | Maximum number of items to collect before stopping | | `loginCookies` | array | — | Browser cookies for authenticated session (optional) | #### Example input (`INPUT.json`) ```json { "startUrls": [ { "url": "https://shopee.vn/search?category=11036030&keyword=xiaomi" }, { "url": "https://shopee.vn/Men-Clothes-cat.11035567" } ], "maxItems": 100 } ```` *** ### Output Each item in the dataset represents one product listing with the following fields: | Field | Type | Description | |---|---|---| | `url` | string | Page URL the item was scraped from | | `itemUrl` | string | Direct product URL (`https://shopee.vn/product/{shopid}/{itemid}`) | | `itemid` | number | Shopee item ID | | `shopid` | number | Shopee shop ID | | `name` | string | Product name | | `brand` | string|null | Brand name | | `shop_name` | string|null | Shop name | | `shop_location` | string|null | Shop location | | `currency` | string | Currency code (e.g. `VND`) | | `price` | number | Current price (in currency units) | | `price_min` | number | Minimum variant price | | `price_max` | number | Maximum variant price | | `price_before_discount` | number|null | Original price before discount | | `discount` | string|null | Discount percentage (e.g. `"8%"`) | | `sold` | number | Monthly sold count | | `historical_sold` | number | All-time sold count | | `liked_count` | number | Number of likes/favourites | | `cmt_count` | number|null | Number of reviews | | `rating_star` | number|null | Average star rating | | `stock` | number|null | Available stock | | `item_status` | string | Status (e.g. `"normal"`) | | `catid` | number | Category ID | | `image` | string|null | Main image URL | | `images` | string\[] | All image URLs | | `is_official_shop` | boolean|null | Whether the seller is an official shop | | `is_on_flash_sale` | boolean|null | Whether item is on flash sale | | `can_use_cod` | boolean|null | Cash on delivery availability | | `ctime` | number | Listing creation timestamp (Unix) | *** ### How it works 1. **Input is read** via `Actor.getInput()`. Start URLs and `maxItems` are extracted. 2. **Cookies are injected** into each page before navigation to maintain a logged-in session. 3. **XHR responses are intercepted** — the crawler listens for responses from: - `/api/v4/search/search_items` (search pages) - `/api/v4/recommend/recommend_v2` (category pages) 4. **Items are extracted and normalised** from whichever API response shape is present, then pushed to the dataset. 5. **Pagination** — after each page, the next-page button's `href` is read from the DOM. If the href points to `"/"` or is absent, crawling stops (last page reached). Otherwise, the next URL is enqueued. 6. **`maxItems` enforcement** — counting is tracked globally; pagination stops as soon as the limit is reached. 7. **Cookies are saved** after each page so the session stays fresh across requests. *** ### Running locally ```bash ## Install dependencies npm install ## Run with local storage (storage/ directory) apify run ## Run and purge previous local storage first apify run --purge ``` *** ### Deploy to Apify ```bash ## Authenticate apify login ## Push and deploy apify push ``` *** ### Notes - Shopee stores prices internally as **micros** (integer × 10⁻⁶). The scraper divides by `1,000,000` to produce real currency values. - Image IDs returned by the API are converted to full CDN URLs using `https://down-vn.img.susercontent.com/file/`. - Proxy configuration (Apify Residential, Vietnam) is defined in `main.js` and can be enabled by uncommenting the `proxyConfiguration` option in the crawler. - [Join our developer community on Discord](https://discord.com/invite/jyEM2PRvMU) # Actor input Schema ## `startUrls` (type: `array`): URLs to start with. ## `maxItems` (type: `integer`): Limit of items to be scraped ## `loginCookies` (type: `array`): If you want to sign in to the web page so that you will have access to more data than with an anonymous profile, but do not wish to save your credentials in input, then you can use your cookies. ## Actor input object example ```json { "startUrls": [ { "url": "https://shopee.vn/Men-Clothes-cat.11035567" } ], "maxItems": 10 } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrls": [ { "url": "https://shopee.vn/Men-Clothes-cat.11035567" } ], "maxItems": 10 }; // Run the Actor and wait for it to finish const run = await client.actor("dtrungtin/shopee-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "startUrls": [{ "url": "https://shopee.vn/Men-Clothes-cat.11035567" }], "maxItems": 10, } # Run the Actor and wait for it to finish run = client.actor("dtrungtin/shopee-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "startUrls": [ { "url": "https://shopee.vn/Men-Clothes-cat.11035567" } ], "maxItems": 10 }' | apify call dtrungtin/shopee-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=dtrungtin/shopee-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Shopee Scraper", "description": "A Puppeteer-based Apify Actor that scrapes product listings from [Shopee Vietnam](https://shopee.vn). Supports **search pages**, **category pages**, and automatically paginates through results up to a configurable item limit.", "version": "0.0", "x-build-id": "3hswAazahK5Bh1N0h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dtrungtin~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dtrungtin-shopee-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/dtrungtin~shopee-scraper/runs": { "post": { "operationId": "runs-sync-dtrungtin-shopee-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/dtrungtin~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-dtrungtin-shopee-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to start with.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "type": "integer", "description": "Limit of items to be scraped", "default": 10 }, "loginCookies": { "title": "Cookies", "type": "array", "description": "If you want to sign in to the web page so that you will have access to more data than with an anonymous profile, but do not wish to save your credentials in input, then you can use your cookies." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```