{ "openapi": "3.0.1", "info": { "title": "Taobao & Tmall Products Scraper", "description": "Scrape Taobao and Tmall products by keyword, shop, category or product link: prices in 11 currencies, shop ratings, reviews, images, category path. Export to CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "pq0zEDN4gxRouCn9B" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~taobao-tmall-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-taobao-tmall-products-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/parseforge~taobao-tmall-products-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-taobao-tmall-products-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/parseforge~taobao-tmall-products-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-taobao-tmall-products-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": { "searchTerms": { "title": "Search keywords", "type": "array", "description": "Keywords to look up in Taobao's public catalogue, one per line. Use Chinese keywords (for example 手机壳, 连衣裙, 蓝牙耳机): every Chinese term we tested has a page, while English terms work only when Taobao indexes them (phone case yes, bluetooth earphones no). Each keyword returns its best-selling products, up to about 41 per keyword.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "Taobao or Tmall product links or numeric item IDs, one per line. Accepts item.taobao.com/item.htm?id=..., detail.tmall.com/item.htm?id=..., world.taobao.com/item/....htm and bare IDs such as 971278517006.", "items": { "type": "string" } }, "shopIds": { "title": "Shop IDs or URLs", "type": "array", "description": "Taobao or Tmall shop IDs (for example 67095450) or world.taobao.com/dianpu/.htm links. Each shop returns up to 60 of its products.", "items": { "type": "string" } }, "categoryIds": { "title": "Category IDs or URLs", "type": "array", "description": "Taobao category IDs (for example 150704 for phone cases) or world.taobao.com/category/.htm links. Each category returns its top 20 products. Category IDs appear in the categoryId column of any product row.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "region": { "title": "Storefront currency", "enum": [ "world", "sg", "my", "au", "nz", "ca", "jp", "kr", "th", "ph", "mo" ], "type": "string", "description": "Taobao's overseas storefront whose currency fills the price column. CNY prices, plus HKD and TWD for search, shop and category rows, are always included.", "default": "world" }, "includeDetails": { "title": "Open each product page", "type": "boolean", "description": "Adds the Tmall or Taobao platform flag, ship-from location, original and promotion price, seller credit level, shop rating scores, shop age, review count, positive rate, review highlights and the latest review. Costs one extra page per product, so switch it off for faster, lighter listing-only runs.", "default": true }, "includeTopRated": { "title": "Include top-rated list", "type": "boolean", "description": "For each keyword, also reads Taobao's top-rated list, which roughly doubles the products per keyword (from 20 to about 41).", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings. Datacenter proxy works; switch to residential if you see repeated slider challenges.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }