{ "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.1", "x-build-id": "Go6iAFxT5VSzU7FdN" }, "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": "A single product keyword (e.g. 'tênis nike'), Shopee search URL, shop URL, or category URL. For multiple inputs, use the arrays below." }, "keywords": { "title": "Multiple keywords", "uniqueItems": true, "type": "array", "description": "List of search keywords. Each keyword yields up to ~150 unique items (Shopee API cap). Combine 10–30 keywords to scrape thousands of products.", "items": { "type": "string" } }, "shopUrls": { "title": "Shop URLs", "uniqueItems": true, "type": "array", "description": "Shopee shop/seller URLs (e.g. 'https://shopee.com.br/lojaname'). Pagination has no real cap — a shop with 5,000 items returns all 5,000.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "uniqueItems": true, "type": "array", "description": "Shopee category URLs (e.g. 'https://shopee.com.br/Tenis-cat.11013548'). Yields more items than keyword search; rotates 4 sort orders.", "items": { "type": "string" } }, "priceSlicing": { "title": "Slice keyword/category by price ranges", "type": "boolean", "description": "When ON, runs each keyword/category 6× across price buckets (0-50, 50-150, 150-300, 300-600, 600-1500, 1500+ BRL) to bypass Shopee's per-search dedup cap. Multiplies BD bandwidth ~6×.", "default": false }, "country": { "title": "Country", "enum": [ "BR", "ID", "TH", "MY", "SG", "PH", "VN", "MX" ], "type": "string", "description": "Country code for Shopee domain (auto-detected from URLs when present).", "default": "BR" }, "maxItems": { "title": "Max products (total across all inputs)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on total items returned across all inputs. Per-keyword cap is ~150; multi-keyword + shop URLs scale to thousands.", "default": 100 }, "debug": { "title": "Debug logs", "type": "boolean", "description": "Enable verbose logging.", "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 } } } } } } } } } }