{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper: Product Search, Prices and Discounts", "description": "Scrape Shopee search results by keyword in 9 markets (SG, MY, TH, PH, VN, TW, ID, BR, MX): one row per product with item and shop id, title, price, price before discount, discount, rating, seller location, promo labels, image and link. Sort by relevance, sales, newest or price. No login.", "version": "0.1", "x-build-id": "yR7rmnNiqJucL8MNv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~shopee-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-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/themineworks~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Search keywords", "type": "array", "description": "What you would type in Shopee's search box, one per line, in any language the market uses. Example: phone case, or ốp lưng iphone on Shopee Vietnam. Up to 100 keywords per run; the same keyword given twice is read once.", "items": { "type": "string" } }, "country": { "title": "Shopee market", "enum": [ "SG", "MY", "TH", "PH", "VN", "TW", "ID", "BR", "MX" ], "type": "string", "description": "Which Shopee site to search. Prices come back in that market's currency.", "default": "SG" }, "maxItems": { "title": "Max products per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The most products to return for each keyword, 1 to 1,000. Shopee shows 40 products per page; the actor reads more pages until it has this many or Shopee has no new products left for the keyword (often 100 to 300 for a broad keyword).", "default": 50 }, "sort": { "title": "Sort by", "enum": [ "relevance", "sales", "newest", "price_asc", "price_desc" ], "type": "string", "description": "The order Shopee ranks the results in, the same choices as the sort bar on the Shopee site.", "default": "relevance" }, "otherSorts": { "title": "Fill up from the other sorts", "type": "boolean", "description": "When a keyword runs out of new products in your sort before reaching max products, read it in the other sorts too (relevance, top sales, latest, both price orders) and add the products not yet delivered. Each row says which sort found it. Turn off to get only your sort.", "default": true }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Keep only products at or above this price, in the market's currency (for example 9.5 for S$9.50, or 50000 for 50.000 VND). Leave empty for no lower limit." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Keep only products at or below this price, in the market's currency. Leave empty for no upper limit." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is. By default the actor uses Apify residential proxies in the market's country, which Shopee answers most reliably. You can pick another proxy group or your own proxy URLs.", "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 } } } } } } } } } }