{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper", "description": "Scrape Shopee product listings by keyword, category, or URL across Brazil, Singapore, Malaysia, Vietnam, Thailand, and Philippines. Returns price, discount, seller, ratings, stock, shipping. Ideal for price monitoring, seller intelligence, and market research. $0.005/product.", "version": "0.4", "x-build-id": "kWHjor3qCKo33PLYF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gio21~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gio21-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/gio21~shopee-scraper/runs": { "post": { "operationId": "runs-sync-gio21-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/gio21~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-gio21-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": { "location": { "title": "Single keyword or URL", "type": "string", "description": "Shorthand for one-off runs: a single product keyword, Shopee search URL, shop URL, or category URL. Example: 'tênis nike'. For batch scraping use the 'keywords', 'categoryUrls', or 'shopUrls' arrays instead." }, "keywords": { "title": "Search keywords", "uniqueItems": true, "type": "array", "description": "List of search keywords (most reliable mode). Each keyword yields up to ~150 unique items (Shopee API cap). Combine 10–30 specific keywords to scrape thousands of products. Example: [\"tênis nike\", \"camiseta dry fit\", \"fone bluetooth\"].", "default": [], "items": { "type": "string" } }, "shopUrls": { "title": "Shop / seller URLs", "uniqueItems": true, "type": "array", "description": "Shopee shop/seller URLs. Example: [\"https://shopee.com.br/lojaname\"]. Note: shop pages are blocked by the unblocking backend's compliance policy and may return nothing — to cover a seller, use 5–10 niche keywords or a category URL instead.", "default": [], "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "uniqueItems": true, "type": "array", "description": "Shopee category URLs. Example: [\"https://shopee.com.br/Tenis-cat.11013548\"]. Yields more items than keyword search; the actor rotates 4 sort orders for maximum coverage.", "default": [], "items": { "type": "string" } }, "priceSlicing": { "title": "Slice keyword/category by price ranges", "type": "boolean", "description": "When true, runs each keyword/category 6× across price buckets in the country's local currency (BRL for BR, THB for TH, IDR for ID, …) to bypass Shopee's per-search dedup cap and pull more unique items. Multiplies bandwidth and runtime ~6×. Example: false.", "default": false }, "country": { "title": "Country / marketplace", "enum": [ "BR", "ID", "TH", "MY", "SG", "PH", "VN", "MX" ], "type": "string", "description": "Country code selecting the Shopee domain. Auto-detected from URLs when present. Example: 'BR' (shopee.com.br).", "default": "BR" }, "maxItems": { "title": "Max products (total across all inputs)", "minimum": 10, "maximum": 10000, "type": "integer", "description": "Hard cap on total items returned across all inputs combined. Per-keyword cap is ~150; multi-keyword + category URLs scale to thousands. Example: 100. Range 10–10000.", "default": 100 }, "debug": { "title": "Debug logs", "type": "boolean", "description": "Enable verbose logging for troubleshooting. Leave off for normal runs. Example: false.", "default": false } } }, "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 } } } } } } } } } }