{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper [From $0.28] Search, Ratings, Sales & Shops", "description": "Shopee scraper from $0.28 per 1,000 products: keywords, shops, categories and product URLs in all 11 Shopee markets, sorted by top sales, newest or price, up to 100 per keyword. Price, discount, rating, brand and seller details in one flat row. No login, no cookies. JSON, CSV or Excel.", "version": "0.1", "x-build-id": "9dOeah3zicYatOIM7" }, "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": { "startUrls": { "title": "Shopee links", "type": "array", "description": "Product, search, category or shop pages from any Shopee marketplace, one per line, e.g. https://shopee.co.id/Name-i.196846900.11083699432, https://shopee.sg/search?keyword=iphone, https://shopee.co.id/Komputer-Aksesoris-cat.11044261 or https://shopee.co.th/bissiq. Each link stays on its own marketplace.", "items": { "type": "string" } }, "searchTerms": { "title": "Keywords", "type": "array", "description": "What to search for, one per line, e.g. iphone 15 or skincare. Each keyword returns about 100 products at most, so add keywords for more. Not needed when links are given.", "items": { "type": "string" } }, "country": { "title": "Marketplace for keywords", "enum": [ "BR", "CL", "CO", "ID", "MY", "MX", "PH", "SG", "TW", "TH", "VN" ], "type": "string", "description": "The Shopee site the keywords are searched on; links keep their own. Colombia and Chile have no keyword search, so use product or shop links there.", "default": "ID" }, "mode": { "title": "How links and keywords are used", "enum": [ "auto", "product", "shop", "search" ], "type": "string", "description": "Every link is read as the kind of page it is, whatever you pick here. Product pages or shop pages: keywords are skipped when links are also given. Product pages: product links also get the full product details.", "default": "auto" }, "discountedOnly": { "title": "On sale only", "type": "boolean", "description": "On: only products shown with a discount badge or a crossed-out price.", "default": false }, "minRating": { "title": "Lowest rating", "type": "number", "description": "0 to 5, e.g. 4.5. Products with no rating yet are kept. Empty: no limit." }, "minPrice": { "title": "Price from", "type": "integer", "description": "In the marketplace's own money, e.g. 50000 for IDR 50,000. Products without a price are dropped. Empty: no limit." }, "maxPrice": { "title": "Price up to", "type": "integer", "description": "In the marketplace's own money, e.g. 200 for MYR 200. Products without a price are dropped. Empty: no limit." }, "sortBy": { "title": "Result order", "enum": [ "relevancy", "latest", "sales", "price_asc", "price_desc" ], "type": "string", "description": "Order of keyword results, best match by default. Category and shop links keep the page's own order; the two price orders sort the products that were read.", "default": "relevancy" }, "enrichProducts": { "title": "Full product details (paid add-on)", "type": "boolean", "description": "Off (default): what the search results show. On: adds the description, brand, all images, the price range and the seller's rating, followers, response rate and official-shop status, billed as product-detail for each product that gets them. Product links always get these details. On the free Apify plan, a run has 20 product lookups in total, counting searches, product links and details.", "default": false }, "maxItems": { "title": "Products in total", "minimum": 1, "type": "integer", "description": "The run stops after this many products, default 40.", "default": 40 }, "maxConcurrency": { "title": "Products read at once", "minimum": 1, "maximum": 8, "type": "integer", "description": "1 to 8, default 3. Higher finishes product links and full details sooner.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify residential by default; a residential proxy in the marketplace's country holds up best. Runs also work with the proxy off.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }