{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper - Product Catalogue Across 8 Markets", "description": "Search Shopee by keyword or category and get one row per product: name, canonical link, shop and item ids, and with details on, the brand, category, seller location, images and attributes. Indonesia, Singapore, Malaysia, Thailand, Vietnam, Philippines, Taiwan and Brazil. Catalogue data, not prices.", "version": "0.1", "x-build-id": "T5MEJV0g9TvCcgHAp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~shopee-scraper/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-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": [ "market" ], "properties": { "market": { "title": "Market", "enum": [ "id", "sg", "my", "th", "vn", "ph", "tw", "br" ], "type": "string", "description": "Which Shopee country site to read. The market is set by this, not by where the request comes from.", "default": "id" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "One per line, in the market's own language. Around forty products come back per term per page.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Shopee category pages, such as /Elektronik-cat.11044258. A full link or a path both work.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Individual products you already have. Combine with the above or use on their own.", "items": { "type": "string" } }, "pagesPerSearch": { "title": "Pages per search term", "minimum": 1, "maximum": 20, "type": "integer", "description": "How deep to walk each search.", "default": 1 }, "fetchDetails": { "title": "Fetch product details", "type": "boolean", "description": "Open each product page for the brand, category id, seller location, images and attributes. Off by default: the listing already carries the name, and this is one request per product.", "default": false }, "maxProducts": { "title": "Maximum products", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many. Also the cost ceiling for the run.", "default": 100 }, "concurrency": { "title": "Parallel detail requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many product pages to open at once when details are on.", "default": 3 }, "attempts": { "title": "Attempts per page", "minimum": 1, "maximum": 15, "type": "integer", "description": "How often to retry through a fresh exit before giving up on a page.", "default": 4 }, "sessionCookies": { "title": "Your Shopee session cookies (optional, unlocks prices)", "type": "object", "description": "Shopee withholds price, stock, rating and sold count from anyone who is not logged in. Paste your own cookies here as name/value pairs and the run uses Shopee's API instead, which carries all four. Without them you get the catalogue only." } } }, "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 } } } } } } } } } }