{ "openapi": "3.0.1", "info": { "title": "Shopee Products Scraper", "description": "E-commerce scraper for Shopee — export product data to JSON, CSV & Excel. Extract prices, sales & reviews from 8 marketplaces.", "version": "0.0", "x-build-id": "Y1kVlmQNmFEOESrbG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devcake~shopee-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devcake-shopee-products-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/devcake~shopee-products-scraper/runs": { "post": { "operationId": "runs-sync-devcake-shopee-products-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/devcake~shopee-products-scraper/run-sync": { "post": { "operationId": "run-sync-devcake-shopee-products-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": [ "cookies" ], "properties": { "searchKeywords": { "title": "Search Keywords", "type": "array", "description": "Product search keywords to find on Shopee. Add multiple keywords to search for different products.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (Direct Shopee Search URLs)", "type": "array", "description": "Optional: Direct Shopee search URLs to scrape. Use this to scrape with specific filters, facets, or sorting. Example: https://shopee.com.mx/search?filters=9&keyword=laptop&noCorrection=true&page=0. Both startUrls and searchKeywords can be used together - results will be combined.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "domain": { "title": "Shopee Domain", "enum": [ "com.mx", "co.id", "com.my", "co.th", "sg", "ph", "vn", "com.br" ], "type": "string", "description": "Shopee domain/country to scrape. IMPORTANT: Cookies must be from the same domain you select here.", "default": "com.mx" }, "maxItems": { "title": "Maximum Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of products to scrape", "default": 60 }, "sortBy": { "title": "Sort By", "enum": [ "relevancy", "price", "sales", "ctime" ], "type": "string", "description": "Sort method for search results", "default": "relevancy" }, "sortOrder": { "title": "Sort Order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sort direction", "default": "desc" }, "cookies": { "title": "Authentication Cookies (REQUIRED)", "minItems": 1, "type": "array", "description": "REQUIRED: Log into Shopee, complete captcha if prompted during login, export cookies using EditThisCookie extension. Checkout readme for detailed information.", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Cookie Name", "description": "Cookie name (e.g., SPC_U, SPC_ST)" }, "value": { "type": "string", "title": "Cookie Value", "description": "Cookie value" }, "domain": { "type": "string", "title": "Domain", "description": "Cookie domain (e.g., .shopee.com.mx)" }, "path": { "type": "string", "title": "Path", "description": "Cookie path", "default": "/" }, "secure": { "type": "boolean", "title": "Secure", "description": "Is cookie secure", "default": true }, "httpOnly": { "type": "boolean", "title": "HTTP Only", "description": "Is cookie HTTP only", "default": false } }, "required": [ "name", "value", "domain" ] } }, "enrichWithShopInfo": { "title": "Enrich with Shop Info", "type": "boolean", "description": "Fetch detailed shop information for each unique shop (slower but more comprehensive data)", "default": false }, "maxShopsToEnrich": { "title": "Max Shops to Enrich", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of unique shops to fetch detailed info for when enrichWithShopInfo is enabled", "default": 50 } } }, "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 } } } } } } } } } }