{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper | All-In-One | $30 / mo", "description": "All-in-one Shopee scraper for 11 countries (ID, MY, TH, BR, SG, MX +). Scrape by keyword or URL. It bypasses blocks and captchas to extract rich product data: prices, sales, ratings, and full seller info. Perfect for competitor analysis and market research.", "version": "0.3", "x-build-id": "hUxSEwg9MuphlNGCC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~shopee-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": [ "shopeeCookies" ], "properties": { "startUrls": { "title": "Start URLs (highest priority)", "type": "array", "description": "A list of Shopee URLs to scrape. Can be search, category, or individual product URLs. Overrides all other settings.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Keywords", "type": "array", "description": "Enter a list of keywords to search for on Shopee. (Ignored if Start URLs are used).", "items": { "type": "string" } }, "country": { "title": "Shopee Country", "enum": [ "ID", "MY", "SG", "TH", "TW", "VN", "PH", "BR", "MX", "CO", "CL" ], "type": "string", "description": "Select the Shopee domain. (Ignored if Start URLs are used).", "default": "TH" }, "shopeeCookies": { "title": "Shopee Cookies (JSON format)", "type": "string", "description": "1. This scraper requires you to be logged in to reliably access Shopee's data. Install EditThisCookie Chrome Extension, Click on the extension and export the cookies. More details on the read me page" }, "scrapeMode": { "title": "Scrape Mode", "enum": [ "fast", "deep" ], "type": "string", "description": "Choose the scraping depth. 'Fast' is efficient, 'Deep' provides more detailed data but is slower. Note: Direct product URLs will always run in 'Deep' mode.", "default": "fast" }, "maxProductsPerSearch": { "title": "Max Products per Search", "type": "integer", "description": "Maximum number of products to scrape for each target. Set to 0 for unlimited. (Ignored for direct product URLs).", "default": 100 }, "sortBy": { "title": "Sort By", "enum": [ "relevancy", "ctime", "sales", "price_asc", "price_desc" ], "type": "string", "description": "The sorting order for search results.", "default": "relevancy" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxy settings. Country-specific Residential proxies are highly recommended." } } }, "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 } } } } } } } } } }