{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper API - Products, Prices, Discounts & Images", "description": "Scrape Shopee products across 11 countries. HTTP only, no browser, pay per result. Full category tree, AggregateOffer price range, seller rating, discount captured.", "version": "0.1", "x-build-id": "UVnjg2HnPI39N4uNV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/makework36~shopee-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-makework36-shopee-scraper-api", "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/makework36~shopee-scraper-api/runs": { "post": { "operationId": "runs-sync-makework36-shopee-scraper-api", "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/makework36~shopee-scraper-api/run-sync": { "post": { "operationId": "run-sync-makework36-shopee-scraper-api", "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": [ "country", "mode" ], "properties": { "country": { "title": "Country", "enum": [ "br", "sg", "my", "th", "ph", "vn", "id", "tw", "mx", "co", "cl" ], "type": "string", "description": "Shopee country/domain to scrape.", "default": "br" }, "mode": { "title": "Mode", "enum": [ "discover", "categories", "urls" ], "type": "string", "description": "Scraping mode. `discover` auto-finds all categories; `categories` uses your list; `urls` scrapes specific product/category URLs.", "default": "discover" }, "categories": { "title": "Category slugs", "type": "array", "description": "Category slugs (with -cat.NNN suffix). Used only when mode=categories. Example: [\"Celulares-e-Dispositivos-cat.11059988\"].", "default": [], "items": { "type": "string" } }, "urls": { "title": "URLs", "type": "array", "description": "Shopee URLs (product pages or category pages). Used only when mode=urls.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxProductsPerCategory": { "title": "Max products per category", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap of unique products to extract from each category. Shopee SSR returns ~40 per sort variant — actor cycles 5 sorts + 3 pages = up to ~200 unique.", "default": 200 }, "maxTotalProducts": { "title": "Max total products", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap for the whole run across all categories.", "default": 2000 }, "sortOrders": { "title": "Sort orders", "uniqueItems": true, "type": "array", "description": "Which sort orders to iterate to maximize unique IDs. More sorts = more unique products per category (up to ~200 with all 5).", "items": { "type": "string", "enum": [ "relevancy", "sales", "ctime", "price", "price_desc" ] }, "default": [ "relevancy", "sales", "price_desc" ] }, "workers": { "title": "Concurrent workers", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel HTTP workers for product fetching.", "default": 8 }, "delayMs": { "title": "Min delay (ms) between requests", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Throttle delay to reduce rate-limit risk. Increase if seeing 302 redirects.", "default": 300 } } }, "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 } } } } } } } } } }