{ "openapi": "3.0.1", "info": { "title": "Shopee Search & Category Scraper - Cheapest", "description": "Search Shopee products by keyword, category URL, or any Shopee listing URL. Optionally enrich each result with full product detail (price variants, stock, images, attributes, seller info) across multiple countries. Fast, lightweight, and no browser or account required.", "version": "0.1", "x-build-id": "k7mvZ31BE3HLxGyhq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~shopee-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-shopee-search", "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/xtracto~shopee-search/runs": { "post": { "operationId": "runs-sync-xtracto-shopee-search", "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/xtracto~shopee-search/run-sync": { "post": { "operationId": "run-sync-xtracto-shopee-search", "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": [ "mode" ], "properties": { "country": { "title": "Country", "enum": [ "id", "sg", "my", "th", "ph", "vn", "br", "tw", "mx", "co", "cl" ], "type": "string", "description": "Shopee regional site. Notes: (1) mode=category is NOT available for Colombia (co) and Chile (cl) — these regions do not expose category pages publicly; the actor will stop early with a clear message. (2) fetchDetail=true returns full product data (description, brand, all variants, attributes, image gallery) only for id/sg/my/th/ph when running on Apify Cloud (residential proxy is used automatically); for other countries you receive a lighter set: title, price, primary image, rating, sold count, seller info.", "default": "id" }, "mode": { "title": "Search mode", "enum": [ "keyword", "category", "url" ], "type": "string", "description": "How to search for products.", "default": "keyword" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword. Required for mode=keyword. Example: 'laptop gaming'" }, "category": { "title": "Category path", "type": "string", "description": "Category slug or full URL. Required for mode=category. Example: /Laptop-cat.11044364.11044440" }, "url": { "title": "Shopee listing URL", "type": "string", "description": "Any Shopee search/category URL. Required for mode=url. Country is auto-detected. Example: https://shopee.co.id/search?keyword=laptop" }, "sort": { "title": "Sort order", "enum": [ "relevancy", "sales", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Sort order for search results.", "default": "relevancy" }, "maxProducts": { "title": "Max products", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of products to return.", "default": 40 }, "minPrice": { "title": "Min price filter", "type": "integer", "description": "Minimum price in local currency. Only for mode=keyword." }, "maxPrice": { "title": "Max price filter", "type": "integer", "description": "Maximum price in local currency. Only for mode=keyword." }, "fetchDetail": { "title": "Fetch full product detail", "type": "boolean", "description": "If enabled, each product card is enriched with full detail: description, brand, all variants, attributes, image gallery, seller info, and more. Uses more requests and takes longer — recommended for small batches (≤20 products). Detail richness varies by country (see the country field for details).", "default": false }, "delay": { "title": "Request delay (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "Delay between HTTP requests.", "default": 1 } } }, "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 } } } } } } } } } }