{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper · Search, Product & Shop · 11 Markets", "description": "Shopee Scraper extracts products from keyword search, category pages, shops, or product URLs across Indonesia, Singapore, Malaysia, Philippines, Thailand, Vietnam, Taiwan, Brazil, Mexico, Colombia and Chile. Price, rating, seller, gallery. No login. Optional full product pages.", "version": "0.1", "x-build-id": "yCAv1XhPfiSzeoQPs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~shopee-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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 to scrape", "enum": [ "auto", "search", "product", "shop" ], "type": "string", "description": "Auto decides from the URL. Search = keyword / list / category. Product = full product pages. Shop = a seller and their listings.", "default": "auto" }, "country": { "title": "Country / marketplace", "enum": [ "ID", "SG", "MY", "PH", "TH", "VN", "BR", "TW", "MX", "CO", "CL" ], "type": "string", "description": "Used for keyword searches. A URL keeps its own country. Colombia and Chile do not serve search HTML — paste product or shop URLs there.", "default": "ID" }, "searchTerms": { "title": "Search keywords", "type": "array", "description": "One keyword per line, searched in the selected marketplace.", "items": { "type": "string" } }, "startUrls": { "title": "Shopee URLs", "type": "array", "description": "Product pages (...-i.shop.item or /product/shop/item), search, category (...-cat.id) or shops.", "items": { "type": "string" } }, "maxItems": { "title": "Max products", "minimum": 1, "type": "integer", "description": "Stop after this many products per run.", "default": 40 }, "enrichProducts": { "title": "Fetch full product details ($)", "type": "boolean", "description": "Open each product page for description, brand, gallery, variants and seller. Billed as product-detail.", "default": false }, "sortBy": { "title": "Sort results", "enum": [ "relevancy", "sales", "latest", "price_asc", "price_desc" ], "type": "string", "description": "Client-side sort. Shopee's crawler pages ignore server sort — price_asc / price_desc reorder cards we already have; sales and latest stay in page order.", "default": "relevancy" }, "minPrice": { "title": "Min price", "type": "integer", "description": "Minimum price in the marketplace currency. Products without a price are dropped." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Maximum price in the marketplace currency. Products without a price are dropped." }, "minRating": { "title": "Minimum rating", "type": "number", "description": "Keep products rated at least this (0–5). Crawler cards often have no rating and are kept." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies in the marketplace country are the most stable. The run still works if you turn this off.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Parallel requests.", "default": 3 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }