{ "openapi": "3.0.1", "info": { "title": "Taobao Tmall 淘宝 Product Scraper - Prices, Sales & Shops", "description": "Search Taobao and Tmall (淘宝/天猫) products by keyword and get price, discount price, sales count, shop name and ID, shop ratings, seller level, ship-from location, stock and images. Filter by price range or Tmall only. No login or cookies needed. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "8XvCbaAXpLvafbvcM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clover_folktale~taobao-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clover_folktale-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/clover_folktale~taobao-scraper/runs": { "post": { "operationId": "runs-sync-clover_folktale-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/clover_folktale~taobao-scraper/run-sync": { "post": { "operationId": "run-sync-clover_folktale-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": { "mode": { "title": "Mode", "enum": [ "search", "questions", "shop", "reviews", "shopProducts" ], "type": "string", "description": "Search products by keyword, read the Q&A (问大家) of items, list the products of shops, or read the buyer reviews of items. When left out (API calls), questions is used if items are given, shop if shops are given, otherwise search." }, "keywords": { "title": "Keywords (mode: search)", "type": "array", "description": "Search keywords, Chinese or English (for example 手机壳 or phone case). Results are collected keyword by keyword until Max results is reached. Falls back to 手机壳 when empty.", "items": { "type": "string" } }, "sort": { "title": "Sort (mode: search)", "enum": [ "sales", "priceHighToLow", "general" ], "type": "string", "description": "Best-selling first, price high to low, or Taobao's general ranking. Used in search mode.", "default": "sales" }, "tmallOnly": { "title": "Tmall only (mode: search)", "type": "boolean", "description": "Only products from Tmall stores. Used in search mode.", "default": false }, "minPrice": { "title": "Min price (CNY) (mode: search)", "minimum": 0, "type": "number", "description": "Only products whose price after discount is at least this many yuan. Used in search mode." }, "maxPrice": { "title": "Max price (CNY) (mode: search)", "minimum": 0, "type": "number", "description": "Only products whose price after discount is at most this many yuan; the list price can be higher. Used in search mode." }, "items": { "title": "Items (modes: questions, reviews)", "type": "array", "description": "Item IDs (the itemId field of search results) or item links containing id=. Short links (e.tb.cn) are not supported. Questions or reviews are collected item by item until Max results is reached.", "items": { "type": "string" } }, "shops": { "title": "Shops (modes: shop, shopProducts)", "type": "array", "description": "Seller IDs (the shopId field of search results) or shop links containing user_id= or user_number_id=. Products are listed shop by shop, newest first, until Max results is reached. In shopProducts mode every entry needs both IDs: the seller ID and the shop ID joined by a colon (for example 1659916565:103710607), or a shop link containing both user_id= and shop_id=; best-selling products come first. A shop request that got no answer is not repeated and its start fees still apply.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of records (products, questions or reviews) to return in total for this run. You are charged per record returned.", "default": 20 } } }, "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 } } } } } } } } } }