{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper - $0.35 / 1000 Products", "description": "Scrape Shopee products as clean JSON from 8 markets (SG, ID, MY, TH, VN, PH, TW, BR): keyword search, category links or product pages. Price, discount, rating, location, images; product pages add description, brand, variations and the shop. No login. $0.35 per 1000 products.", "version": "0.1", "x-build-id": "G87F94T6ZpHbBNWkg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeunblocker~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeunblocker-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/scrapeunblocker~shopee-scraper/runs": { "post": { "operationId": "runs-sync-scrapeunblocker-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/scrapeunblocker~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeunblocker-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": { "searches": { "title": "Search keywords", "type": "array", "description": "Keywords to search in the chosen Shopee market (one search each), e.g. 'iphone case'. Each search returns up to 'Max products per search' products.", "items": { "type": "string" } }, "searchUrls": { "title": "Search or category links", "type": "array", "description": "Shopee search or category links, e.g. https://shopee.sg/search?keyword=lego or https://shopee.sg/Cases-Covers-cat.11013350.11013434.11027839. The link's own market, filters and sort are used.", "items": { "type": "string" } }, "productUrls": { "title": "Product links", "type": "array", "description": "Shopee product links (https://shopee.sg/...-i.. or https://shopee.co.id/product//). Each returns one product with its price, rating, images and shop profile, plus description, brand, categories, variations and attributes where Shopee shows them.", "items": { "type": "string" } }, "country": { "title": "Market", "enum": [ "sg", "id", "my", "th", "vn", "ph", "tw", "br" ], "type": "string", "description": "Shopee market for the keyword searches. Prices come in that market's currency. Links carry their own market.", "default": "sg" }, "sort": { "title": "Sort keyword searches by", "enum": [ "relevance", "sales", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Result order for the keyword searches.", "default": "relevance" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keyword searches: only products at or above this price (whole units of the market's currency)." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keyword searches: only products at or below this price (whole units of the market's currency)." }, "maxResultsPerSearch": { "title": "Max products per search", "minimum": 1, "maximum": 40, "type": "integer", "description": "How many products to keep from each search or link (1-40). Shopee shows one results page of up to 40 products per search.", "default": 40 }, "concurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many searches or products to fetch at the same time (1-5).", "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 } } } } } } } } } }