{ "openapi": "3.0.1", "info": { "title": "Taobao Scraper — Tmall & Taobao Products, Prices & Shops", "description": "Taobao & Tmall (淘宝/天猫) scraper, no login: products for any keyword with price, promotion label, shop, shop score, category, image and review tags, expanded through Taobao's related searches to thousands of items, plus item details (ship-from city, Tmall/Taobao, shop ratings, reviews) by URL or ID.", "version": "1.0", "x-build-id": "xdqitBaacJKDmiTcT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~taobao-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-taobao-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/logiover~taobao-scraper/runs": { "post": { "operationId": "runs-sync-logiover-taobao-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/logiover~taobao-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-taobao-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": { "keywords": { "title": "Search keywords", "type": "array", "description": "What you would type into Taobao's search box, in Chinese or English: \"蓝牙耳机\", \"连衣裙\", \"空气炸锅\", \"phone case\". Each keyword returns Taobao's best-selling products for it (20 per keyword page) and, with \"Expand with related searches\" on, the products of Taobao's own related searches for it (e.g. 蓝牙耳机 → 蓝牙耳机降噪, 蓝牙耳机运动 …) until the per-keyword limit is reached. You can also paste Taobao / Tmall search URLs (s.taobao.com/search?q=…) or catalogue URLs (www.taobao.com/list/product/….htm).", "items": { "type": "string" } }, "expandKeywords": { "title": "Expand with related searches", "type": "boolean", "description": "On (recommended): after a keyword's own page, follow Taobao's search suggestions for it and the keyword's category, so one keyword yields hundreds or thousands of relevant products. Off: exactly the 20 best sellers Taobao shows for each keyword.", "default": true }, "maxItemsPerKeyword": { "title": "Max products per keyword", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop expanding a keyword once this many unique products came from it. 0 = no per-keyword limit (the run stops at \"Max products\").", "default": 200 }, "maxItems": { "title": "Max products", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Upper limit for the whole run (all keywords, categories and item URLs together). Every product appears once (de-duplicated by item ID). 0 = no limit.", "default": 1000 }, "includeDetails": { "title": "Include item details", "type": "boolean", "description": "Also open every product's public Taobao page and add: Tmall or Taobao, seller ID and type, ship-from city (发货地), category path, the price shown on the product page, shop ratings (description / service / logistics), shop opening date, shop size, credit level, review count (e.g. 400+), what buyers mention (e.g. 22人说它物流速度很快), a recent review and payment methods. One extra page per product — about 5 products per second instead of 40, same price per result.", "default": false }, "itemUrls": { "title": "Item URLs or IDs", "type": "array", "description": "Taobao or Tmall product links or plain item IDs: https://item.taobao.com/item.htm?id=…, https://detail.tmall.com/item.htm?id=…, https://www.taobao.com/list/item/….htm or 1079804116256. Each one becomes a row with full item details. Items that Taobao does not publish in its public catalogue (removed, restricted, adult or alcohol products) are reported in the run summary instead.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Taobao category IDs or catalogue category URLs (https://www.taobao.com/list/category/1512.htm). Each category gives its best-selling products and, with expansion on, the products of the category name's related searches. Category IDs appear in every result row (categoryId, rootCategoryId).", "items": { "type": "string" } }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 32, "type": "integer", "description": "How many pages are fetched at the same time. The default is tuned for speed without tripping Taobao's anti-bot checks.", "default": 12 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: the Actor chooses the route itself (direct, then Apify datacenter proxy, then a residential rescue only when Taobao refuses an address). Set a proxy only if you need your own; Chinese residential addresses are refused by these pages.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }