{ "openapi": "3.0.1", "info": { "title": "Shopee Product Scraper — No Login", "description": "Extract Shopee product data without login: local price/currency, seller, rating, optional seller-rating scope when available, availability, IDs, and canonical URL. Choose 14 official Shopee storefronts; Singapore is Verified and 13 are Beta pending market-local canaries. Incomplete rows are skipped.", "version": "0.1", "x-build-id": "h2J17tOo5RsJtpnjy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kazkn~shopee-product-scraper-no-login/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kazkn-shopee-product-scraper-no-login", "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/kazkn~shopee-product-scraper-no-login/runs": { "post": { "operationId": "runs-sync-kazkn-shopee-product-scraper-no-login", "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/kazkn~shopee-product-scraper-no-login/run-sync": { "post": { "operationId": "run-sync-kazkn-shopee-product-scraper-no-login", "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": { "market": { "title": "🌎 Shopee storefront", "enum": [ "auto", "id", "sg", "my", "th", "ph", "vn", "br", "tw", "mx", "co", "cl", "kh", "ar", "la" ], "type": "string", "description": "Choose one storefront for product searches. Use Detect from URL only when you paste a single public Shopee URL. Argentina keyword search is currently unavailable and stops before any network request.", "default": "sg" }, "searchTerms": { "title": "🔎 Product keywords (optional alternative)", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Optional keyword mode: clear the prefilled product URL, then enter product names such as `wireless earbuds`, `running shoes`, or `phone case`. Each phrase is searched independently in the selected storefront.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "startUrls": { "title": "✅ Verified product URL — ready to run", "maxItems": 100, "type": "array", "description": "The prefilled Singapore product is the stable one-click example used by Apify's automated health test. Replace it with another public Shopee product URL, or clear it before using keyword search. A product URL can return exact identity, title, price, rating, optional seller rating scope when available, and explicit availability.", "items": { "type": "object", "required": [ "url" ], "additionalProperties": false, "properties": { "url": { "type": "string", "title": "Shopee URL", "description": "A public HTTPS Shopee search or product URL matching the selected storefront.", "pattern": "^https://" } } } }, "maxItems": { "title": "📦 Products to return", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many unique, complete product rows across all searches or URLs.", "default": 1 }, "sort": { "title": "↕️ Result order", "enum": [ "relevancy", "sales", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Best match is recommended. Change this only when you need best-selling, newest, or price ordering. Direct product URLs are unaffected.", "default": "relevancy" }, "minPrice": { "title": "Legacy minimum price", "minimum": 0, "type": "integer", "description": "Hidden compatibility field for existing API clients." }, "maxPrice": { "title": "Legacy maximum price", "minimum": 0, "type": "integer", "description": "Hidden compatibility field for existing API clients." }, "maxPages": { "title": "📄 Pages to check at most", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard ceiling for Shopee search pages across the run. This limits time and platform usage; it does not force every page to open.", "default": 1 }, "request_id": { "title": "Legacy request ID", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{2,127}$", "type": "string", "description": "Hidden compatibility identifier for API clients and resumable diagnostics.", "default": "shopee-run" }, "mode": { "title": "Legacy mode", "pattern": "^(keyword|url|detail)$", "type": "string", "description": "Hidden compatibility selector. The friendly form detects the source automatically." }, "keyword": { "title": "Legacy keyword", "minLength": 1, "maxLength": 200, "type": "string", "description": "Hidden single-keyword compatibility field." }, "url": { "title": "Legacy URL", "pattern": "^https://", "type": "string", "description": "Hidden single-URL compatibility field." }, "shop_id": { "title": "Legacy shop ID", "pattern": "^[0-9]{1,32}$", "type": "string", "description": "Hidden decimal shop identifier for API detail mode." }, "item_id": { "title": "Legacy item ID", "pattern": "^[0-9]{1,32}$", "type": "string", "description": "Hidden decimal product identifier for API detail mode." }, "max_items": { "title": "Legacy maximum products", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hidden snake_case compatibility limit." }, "max_pages": { "title": "Legacy maximum pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hidden snake_case compatibility limit." }, "cursor": { "title": "Resume cursor", "minLength": 1, "maxLength": 512, "type": "string", "description": "Hidden recovery cursor returned by a previous compatible API run." }, "min_price": { "title": "Legacy minimum price", "minimum": 0, "type": "integer", "description": "Hidden snake_case compatibility filter." }, "max_price": { "title": "Legacy maximum price", "minimum": 0, "type": "integer", "description": "Hidden snake_case compatibility filter." }, "request_delay_ms": { "title": "Legacy request delay", "minimum": 1000, "maximum": 10000, "type": "integer", "description": "Hidden snake_case compatibility delay." }, "requestDelayMs": { "title": "Request delay", "minimum": 1000, "maximum": 10000, "type": "integer", "description": "Hidden safe delay between successful page requests.", "default": 1000 } } }, "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 } } } } } } } } } }