{ "openapi": "3.0.1", "info": { "title": "Shopee Multi-Region Scraper (SG MY PH ID TH VN)", "description": "Scrape product listings, prices, sales volumes, ratings, and shop details from all 6 Shopee markets, Singapore, Malaysia, Philippines, Indonesia, Thailand, and Vietnam in one run. Keyword search, product URLs, and full shop scraping. Export to JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "A6rf244eTtrKkjb99" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/enrico_7~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-enrico_7-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/enrico_7~shopee-scraper/runs": { "post": { "operationId": "runs-sync-enrico_7-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/enrico_7~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-enrico_7-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": { "mode": { "title": "What do you want to scrape?", "enum": [ "keyword_search", "product_detail", "shop_detail" ], "type": "string", "description": "Choose how you want to find products. Keyword Search works like typing into Shopee's search bar. Product Detail and Shop Pages require you to paste Shopee URLs below.", "default": "keyword_search" }, "keywords": { "title": "Keywords", "type": "array", "description": "What to search for on Shopee. Each keyword runs a separate search. Examples: wireless earbuds, phone case, running shoes. Only used in Keyword Search mode.", "items": { "type": "string" }, "default": [ "wireless earbuds" ] }, "urls": { "title": "Shopee URLs", "type": "array", "description": "Paste Shopee product or shop links here, one per line.\n\nFor product pages, copy the URL from any Shopee product listing. It looks like: https://shopee.sg/Product-Name-i.123456789.987654321\n\nFor shop pages, go to a seller's Shopee storefront and copy the URL. It looks like: https://shopee.sg/shopname\n\nOnly used in Product Detail and Shop Pages modes.", "items": { "type": "string" }, "default": [] }, "region": { "title": "Shopee Region", "enum": [ "sg", "my", "ph", "id", "th", "vn" ], "type": "string", "description": "Which Shopee market to scrape. Each region is a separate Shopee site with its own prices, sellers, and currency. To scrape multiple regions, run the Actor once per region.", "default": "sg" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many products to return. Start with 50 to 100 to test. Each Shopee search page returns up to 60 products, so set higher values for deeper research. Maximum: 10,000.", "default": 100 }, "cookie": { "title": "Shopee Session Cookie", "type": "string", "description": "Required. A session cookie is a temporary token from your browser that lets the scraper access Shopee. It expires after 24 to 48 hours and cannot be used to make purchases or change your account.\n\nHow to get it:\n1. Open Chrome and log in to the Shopee site for your region (e.g. shopee.sg or shopee.com.my)\n2. Press F12 to open DevTools, then click the Network tab\n3. Click on any request shown in the list on the left\n4. Check the Request URL at the top of the Headers panel on the right. Make sure it shows your Shopee domain (e.g. shopee.sg). If it shows shopeemobile.com, that is the mobile version and will not work. Click a different request.\n5. Scroll down in the Headers panel until you reach the Cookie section under Request Headers\n6. Copy the entire cookie value. It is a long string that typically starts with _ga= followed by many more values separated by semicolons. Copy all of it.\n7. Paste the full value into this field\n\nIf your run returns 0 results, your cookie has likely expired. Repeat these steps to get a fresh one.", "default": "" } } }, "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 } } } } } } } } } }