# Shopee Scraper (`best_scraper/shopee-scraper`) Actor All-in-one unofficial shopee scraper support almost all of the endpoint you need to scrape the shopee data. You can scrape product sales, discount, ratings, search products, recommendation, official shop, flashsale, and more by using cookies account - **URL**: https://apify.com/best\_scraper/shopee-scraper.md - **Developed by:** [Best Scraper](https://apify.com/best_scraper) (community) - **Categories:** E-commerce - **Stats:** 1,342 total users, 7 monthly users, 100.0% runs succeeded, 21 bookmarks - **User rating**: 3.40 out of 5 stars ## Pricing $40.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## 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 This actor enables you to directly access Shopee's unofficial API, which powers its frontend and provides all the data displayed on the website. You can seemlessly fetch detailed information such as product sales, discounts, ratings, search results, recommendations, official shop details, flash sales, and more by utilizing account cookies. The API Scraper manages all the complex aspects, sparing you from the headache of handling these details yourself. ### Available Endpoints The following table outlines the available API endpoints for accessing various data through the Shopee Scraper. Each endpoint serves a specific purpose, allowing you to retrieve detailed information on categories, search results, product details, recommendations, shop details, flash sales, and more. | API Path | Description | Method | Example Parameters | | -------------------------------------------------------- | ------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `/api/v2/category_list/get` | Retrieve category list | GET | - | | `/api/v4/search/search_facet` | Get search facets for filtering | GET | - | | `/api/v4/search/search_items` | Search for items by keywords | GET | `by=relevancy&rating_filter=4&categoryids=100194&limit=60&match_id=1104429` | | `/api/v4/recommend/recommend` | Retrieve personalized recommendations | GET | - | | `/api/v4/collection/get_items` | Get items from a specific collection | GET | `by=relevancy&limit=100&offset=0&order=desc&page_type=collection&scenario=PAGE_COLLECTION&version=2&view_session_id=335cbf9b-c016-4353-aa58-27b545b66da9&collection_id=123123&item_order=0&limit=60&source=3` | | `/api/v4/microsite/campaign_site_page` | Access campaign site pages | GET | - | | `/api/v4/campaign_collection/get_campaign_list` | List available campaign collections | GET | - | | `/api/v4/homepage/mall_shops` | Retrieve featured mall shops | GET | - | | `/api/v4/shop/get_shop_tab` | Access specific shop tabs | POST | `{"shopid":123123}` | | `/api/v4/shop/rcmd_items` | Get shop items list | GET | `bundle=shop_page_category_tab_main&limit=100&offset=100&shop_id=123123&sort_type=1&upstream=` | | `/api/v4/shop/search_items` | Search items within a shop | GET | `by=relevancy&rating_filter=4&categoryids=100194&limit=60&match_id=1104429` | | `/api/v4/shop/get_shop_base` | Retrieve basic shop information | GET | `shopid=123123` | | `/api/v4/product/get_shop_info` | Get detailed shop information | GET | `shopid=123123` | | `/api/v4/flash_sale/get_all_sessions` | List all flash sale sessions | GET | `category_personalization_type=1&tracker_info_version=1` | | `/api/v4/flash_sale/get_all_itemids` | Get item IDs in a flash sale | GET | `need_personalize=true&promotionid=123123&sort_soldout=false` | | `/api/v4/flash_sale/flash_sale_batch_get_items` | Retrieve flash sale items in batches | POST | `{"promotionid":66229947863041,"categoryid":0,"itemids":[23419068712],"limit":16,"with_dp_items":true}` | | `/api/v4/flash_sale/brand_sale_get_all_shops_item_ids` | Get all item IDs for brand sales | GET | - | | `/api/v4/flash_sale/brand_sale_get_all_sessions` | Retrieve all sessions for brand sales | GET | - | | `/api/v4/pdp/get` | Get product details page (PDP) info | GET | `item_id=28211708960&shop_id=1394297` | | `/api/v4/pdp/get_rw` | Access product details v2 | GET | `item_id=28211708960&shop_id=1394297` | | `/api/v2/item/get_ratings` | Retrieve ratings for an item | GET | `itemid=4269625641&limit=6&offset=0&shopid=39425361` | | `/api/v4/item/get_list` | Bulk product details | POST | `{"shop_item_ids":[{"shop_id":37667557,"item_id":25119194921}],"source":"microsite_individual_product"}` | ### Example Usage with Apify Request Schema To make a request with the Shopee API Scraper, you can define the `requests` parameter in JSON format as shown below. Be sure to add your Shopee account cookies for enhanced data access. This example demonstrates how to fetch product reviews. ### How to scrape Shopee? #### Getting started Get started with Shopee API Scraper by following these simple steps: **Start**: Click on Try for free. **Prepare Requests**: Specify the API request URLs you wish to scrape. Refer to the API reference section for guidance. Example URLs include: - Search for popular products by keyword: https://shopee.ph/api/v4/search/search_items?keyword=torso - Retrieve top categories: https://shopee.ph/api/v4/pages/get_category_tree - List products by category: https://shopee.ph/api/v4/search/search_items?match_id=11027757 - List products by shop: https://shopee.ph/api/v4/shop/rcmd_items?shop_id=39425361 - Access product detail: https://shopee.ph/api/v4/pdp/get_rw?item_id=4269625641&shop_id=39425361 - Access product ratings: https://shopee.ph/api/v2/item/get_ratings?itemid=4269625641&limit=6&offset=0&shopid=39425361 **Execution**: Click Start and wait for the results. The status will switch from Running to Succeeded upon completion. **Results**: Access your data in the Storage tab, available in various formats like JSON, CSV, and more. Example Input: ```json { "requests": [ { "url": "https://shopee.co.id/api/v4/pdp/get_rw?item_id=28211708960&shop_id=1394297", "method": "GET", }, { "url": "https://shopee.co.id/api/v4/flash_sale/flash_sale_batch_get_items", "method": "POST", "payload": "{\"promotionid\":66229947863041,\"categoryid\":0,\"itemids\":[23419068712,11077890837,13268587518,24663561722,22456442694,21185747156,21678147556,17910422893,22254627658,18657547854,10855609617,11264869002,13793758485,25605244917,22482701323,12854902761],\"limit\":16,\"with_dp_items\":true}" } ], "cookie": "" } ```` Example Output: ```json [ { "bff_meta": null, "error": null, "error_msg": null, "data": { "item": { "item_id": 22629118746, "shop_id": 27731952, "item_status": "normal", "status": 1, "item_type": 0, "reference_item_id": "", "title": "RAINBOWCO Brooklyn Korean Baseball Cap Unisex Fashion Cap For Men And Women Outdoor Sumbrero", "image": "ph-11134201-23030-qr69g073f8nvfe", "label_ids": [ 29, 1002657, 1013151, 844931064601283, 844931086908638, 1563576, 22, 1400290061, 298628331, 1718073025, 1119699, 700610229, 13, 839709523705368, 1048596, 1048595, 822059952759830, 831765669597722, 700020221, 700610210, 1717997940, 997971007, 298623321 ], "is_adult": false, "is_preview": false, "flag": 196608, "is_service_by_shopee": false, "condition": 1, "cat_id": 100009, "has_low_fulfillment_rate": false, "is_live_streaming_price": null, "currency": "PHP", "brand": null, "brand_id": 0, "show_discount": 73, "ctime": 1677843336, "item_rating": { "rating_star": 4.6801654142921985 }, "cb_option": 0, "has_model_with_available_shopee_stock": false, "shop_location": "", "spl_info": null, "estimated_days": 1, "is_pre_order": false, "is_free_shipping": false, "overall_purchase_limit": null, "min_purchase_limit": 1, "is_hide_stock": false, "stock": null, "normal_stock": null, "current_promotion_reserved_stock": 0, "can_use_wholesale": false, "wholesale_tier_list": [], "price": 5500000, "raw_discount": 73, "hidden_price_display": null, "price_min": 5500000, "price_max": 5500000, "price_before_discount": 20000000, "price_min_before_discount": 20000000, "price_max_before_discount": 20000000, "other_stock": 0, "discount_stock": null, "current_promotion_has_reserve_stock": false, "complaint_policy": null, "show_recycling_info": false, "should_show_amp_tag": true, "all_models_has_pre_order": false, "is_item_inherited": false, "max_quantity": 4867 }, ... } ... }, ... ] ``` Your Shopee account browser cookies are not stored and will be encrypted or redacted by Apify. After the process is finished, they will be destroyed. ### About Cookies We are not responsible for any potential account bans. Please use this actor wisely and ensure that you follow Shopee's terms of service when using the scraper. ### Is it legal to scrape Shopee? Scraping publicly available data such as product descriptions, prices, or ratings is generally legal. However, you should always review the terms of service of the website you're scraping and ensure compliance with applicable laws. For more information, you can read Apify's blog post on the [legality of web scraping](https://blog.apify.com). ### Share Your Feedback We value your feedback! If you have any suggestions for improvements, encounter any bugs, or have any other comments, feel free to create an issue in the Actor's issues tab in the Apify Console. # Actor input Schema ## `requests` (type: `array`): Enter the bulk requests for shopee scraper ## `cookie` (type: `string`): Enter shopee browser cookies as a string or JSON array. Use Copy Cookies extension to export cookies as JSON. (See guide here). By default the system uses our predefined cookies. If you encounter errors, use your own cookie here. Your cookies are not stored and will be encrypted/redacted by Apify. ## Actor input object example ```json { "requests": [ { "url": "https://shopee.co.id/api/v4/pdp/get_rw?item_id=28211708960&shop_id=1394297" } ] } ``` # 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 = { "requests": [ { "url": "https://shopee.co.id/api/v4/pdp/get_rw?item_id=28211708960&shop_id=1394297" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("best_scraper/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 = { "requests": [{ "url": "https://shopee.co.id/api/v4/pdp/get_rw?item_id=28211708960&shop_id=1394297" }] } # Run the Actor and wait for it to finish run = client.actor("best_scraper/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 '{ "requests": [ { "url": "https://shopee.co.id/api/v4/pdp/get_rw?item_id=28211708960&shop_id=1394297" } ] }' | apify call best_scraper/shopee-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=best_scraper/shopee-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Shopee Scraper", "description": "All-in-one unofficial shopee scraper support almost all of the endpoint you need to scrape the shopee data. You can scrape product sales, discount, ratings, search products, recommendation, official shop, flashsale, and more by using cookies account", "version": "0.0", "x-build-id": "zufSSGHdfbEz2jF5j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/best_scraper~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-best_scraper-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/best_scraper~shopee-scraper/runs": { "post": { "operationId": "runs-sync-best_scraper-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/best_scraper~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-best_scraper-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", "required": [ "requests" ], "properties": { "requests": { "title": "Enter your specified requests", "minItems": 1, "maxItems": 100, "type": "array", "description": "Enter the bulk requests for shopee scraper", "default": [ { "url": "https://shopee.co.id/api/v4/pdp/get_rw?item_id=28211708960&shop_id=1394297" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "cookie": { "title": "Account cookies", "type": "string", "description": "Enter shopee browser cookies as a string or JSON array. Use Copy Cookies extension to export cookies as JSON. (See guide here). By default the system uses our predefined cookies. If you encounter errors, use your own cookie here. Your cookies are not stored and will be encrypted/redacted by Apify." } } }, "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 } } } } } } } } } } ```