{
"openapi": "3.0.1",
"info": {
"title": "Shopee.tw Product Scraper — Bulk Product Pages",
"description": "Bulk-scrape public Shopee Taiwan product pages by URL or shopId+itemId — title, stock, images, variants, and shop signals. Prices often stripped on anonymous SSR; partner enrich helps when available. Unofficial; not affiliated with Shopee.",
"version": "0.1",
"x-build-id": "lR3m26vMvjVdsNcAf"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/bakos_bence~shopee-tw-products/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-bakos_bence-shopee-tw-products",
"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/bakos_bence~shopee-tw-products/runs": {
"post": {
"operationId": "runs-sync-bakos_bence-shopee-tw-products",
"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/bakos_bence~shopee-tw-products/run-sync": {
"post": {
"operationId": "run-sync-bakos_bence-shopee-tw-products",
"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": {
"startUrls": {
"title": "Shopee.tw product links",
"type": "array",
"description": "Copy from the product page address bar — canonical form: https://shopee.tw/product/598490793/57509316914. Slug URLs with -i.shop.item also work.",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"title": "Product URL",
"description": "Public shopee.tw product page"
}
},
"required": [
"url"
]
},
"default": [
{
"url": "https://shopee.tw/product/598490793/57509316914"
}
]
},
"urls": {
"title": "URL list (alias)",
"type": "array",
"description": "Plain string URLs — same as product links above.",
"items": {
"type": "string"
}
},
"shopIds": {
"title": "Shop IDs (with Item IDs)",
"type": "array",
"description": "Numeric shop IDs — add matching Item IDs below, one pair per row order.",
"items": {
"type": "string"
}
},
"itemIds": {
"title": "Item IDs (with Shop IDs)",
"type": "array",
"description": "Numeric item IDs — zipped in order with Shop IDs when you skip pasting full URLs.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "Max products this run",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Stop after this many products. Use 1–3 for cheap tests; raise for catalog batches.",
"default": 1
},
"enrichShop": {
"title": "Include shop name & rating",
"type": "boolean",
"description": "Add public shop signals (name, followers, rating, verified flags). No seller personal contact fields.",
"default": true
},
"browserEnrich": {
"title": "Browser fallback for missing price",
"type": "boolean",
"description": "Slower path: open the product in a browser when HTTP + partners still leave price empty. Off by default — try partner enrich first.",
"default": false
},
"includeRawPdp": {
"title": "Include raw product JSON",
"type": "boolean",
"description": "Attach full Shopee product-page payload for power users. On by default.",
"default": true
},
"partnerEnrich": {
"title": "Fill price via Feebee / BigGo",
"type": "boolean",
"description": "When Shopee strips price from the page, look up the same URL on Taiwan price trackers. On by default — improves price coverage.",
"default": true
},
"maxRetries": {
"title": "Retries per product",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "How many times to retry a failed product before marking it failed.",
"default": 3
},
"dedupe": {
"title": "Remove duplicate products",
"type": "boolean",
"description": "On = one row per shopId+itemId. Off only for stress tests.",
"default": true
},
"warmSession": {
"title": "Warm Shopee session first",
"type": "boolean",
"description": "Visit shopee.tw once before scraping to collect cookies — helps avoid empty shells.",
"default": true
},
"productUrls": {
"title": "Product URLs (alias)",
"type": "array",
"description": "Same as Shopee.tw product links — for tasks migrated from other Shopee Actors.",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"title": "Product URL",
"description": "Public shopee.tw product page"
}
},
"required": [
"url"
]
}
},
"browserEnrichFallback": {
"title": "Browser fallback when price missing (alias)",
"type": "boolean",
"description": "Same as Browser fallback for missing price.",
"default": false
},
"requestDelayMs": {
"title": "Pause between products (ms)",
"minimum": 0,
"maximum": 10000,
"type": "integer",
"description": "Optional delay between products. 0 = fastest. Non-zero forces one product at a time.",
"default": 0
},
"concurrency": {
"title": "Products fetched in parallel",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "4–8 is a good balance with TW residential proxy. Higher can trigger soft blocks.",
"default": 4
},
"proxyConfiguration": {
"title": "Apify Proxy configuration",
"type": "object",
"description": "Managed by the Actor; leave default. RESIDENTIAL + TW is forced in code (user toggles are ignored).",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
],
"apifyProxyCountry": "TW"
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}