{ "openapi": "3.0.1", "info": { "title": "Shopee Search Suggestions Scraper (11 Markets)", "description": "Get Shopee search suggestions for any keyword in 11 Shopee markets: suggested queries with linked product and shop IDs, product images and ranking scores, plus keyword hints, search filters and the category tree.", "version": "0.5", "x-build-id": "L5jpwZN78R00V660D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~shopee-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-shopee-search-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/lentic_clockss~shopee-search-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-shopee-search-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/lentic_clockss~shopee-search-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-shopee-search-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": { "fetchMode": { "title": "Fetch mode", "enum": [ "suggestions", "products", "discover", "shop" ], "type": "string", "description": "What to fetch. 'suggestions' returns search-suggestion signals. 'products' returns related product listings for a seed (itemUrl / itemId+shopId / keyword). 'discover' returns the market's daily-discover feed. 'shop' returns a shop profile with its categories.", "default": "suggestions" }, "keyword": { "title": "Keyword", "type": "string", "description": "Shopee search keyword. Used by suggestions, products (keyword-resolved seed) and discover modes; not required for shop mode.", "default": "phone case" }, "keywords": { "title": "Keywords", "maxItems": 100, "type": "array", "description": "Optional keyword list. Each keyword can return up to limit Dataset rows. When set, this list takes precedence over keyword.", "items": { "type": "string", "minLength": 1 } }, "itemUrl": { "title": "Shopee product URL", "type": "string", "description": "For products mode: a Shopee product URL like https://shopee.sg/...-i... Takes precedence over itemId/shopId." }, "itemId": { "title": "Item ID", "type": "string", "description": "For products mode: explicit Shopee item id (used together with shopId when itemUrl is not set)." }, "shopId": { "title": "Shop ID", "type": "string", "description": "For products mode (with itemId) or shop mode. The numeric Shopee shop id." }, "shopUsername": { "title": "Shop username", "type": "string", "description": "For shop mode: the shop's @username alternative to shopId." }, "market": { "title": "Shopee market / country or region", "enum": [ "PH", "SG", "MY", "TH", "TW", "VN", "ID", "BR", "MX", "CO", "CL" ], "type": "string", "description": "Target Shopee country/region. The worker picks the exit for that market; do not pass a proxy.", "default": "SG" }, "limit": { "title": "Rows per input", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum Dataset rows for each input (keyword / product seed / shop). Default 70; the whole run stops at your maximum total charge. Free Apify plan: 200 rows per run and 10 runs of this Actor.", "default": 70 }, "includeFilterConfig": { "title": "Include search filters", "type": "boolean", "description": "In suggestions mode, include Shopee's search filter configuration in the SEARCH_SIGNALS key-value record. Does not fetch product details.", "default": false }, "includeCatTree": { "title": "Include category tree", "type": "boolean", "description": "In suggestions mode, also save the market's full Shopee category tree (root categories with nested children: catid, parent catid, name, display name, images, level) to the CATEGORY_TREE key-value record.", "default": false }, "includeSearchFacet": { "title": "Include search facet", "type": "boolean", "description": "In products mode, attach the keyword's search facet and a category breadcrumb for the first items. In shop mode, attach the market's Shopee Mall category list.", "default": false } } }, "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 } } } } } } } } } }