{ "openapi": "3.0.1", "info": { "title": "Taobao & Tmall Product Scraper - Prices, Sellers & Ratings", "description": "Scrape Taobao and Tmall products by keyword, category, shop or item URL: CNY prices plus HKD/TWD or a world storefront's money, shop, category, seller DSR scores, rating split, latest review, ship-from city and English titles. $1.00 per 1,000 products. No login.", "version": "0.1", "x-build-id": "VRGtbaJetOJt7dhOR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~taobao-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-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/topapi~taobao-scraper/runs": { "post": { "operationId": "runs-sync-topapi-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/topapi~taobao-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-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": "πŸ” Keywords", "type": "array", "description": "Search terms, Chinese or English, e.g. \"ζ‰‹ζœΊε£³\", \"θ“η‰™θ€³ζœΊ\", \"phone case\". An English term without its own Taobao page is searched again in Chinese.", "items": { "type": "string" } }, "itemUrls": { "title": "πŸ›οΈ Product URLs or IDs", "type": "array", "description": "item.taobao.com, detail.tmall.com, world.taobao.com or m.intl.taobao.com links, or bare item ids, e.g. 730344766230. One row each, from the item page.", "items": { "type": "string" } }, "categoryIds": { "title": "πŸ—‚οΈ Category IDs", "type": "array", "description": "Taobao category ids or www.taobao.com/list/category/.htm links, e.g. 150704. Each gives the category's 20 best sellers.", "items": { "type": "string" } }, "shopIds": { "title": "πŸͺ Shop IDs", "type": "array", "description": "Shop ids or links (world.taobao.com/dianpu/.htm, shop.taobao.com), e.g. 72104903. Each gives the shop's first screen of up to 60 products.", "items": { "type": "string" } }, "startUrls": { "title": "πŸ”— Start URLs", "type": "array", "description": "Any mix of Taobao links: product pages, keyword list pages (/list/product/.htm), s.taobao.com searches, categories or shops. Each is routed to the right mode.", "items": { "type": "string" } }, "urlsFromFile": { "title": "πŸ“„ Import URLs from a file", "type": "string", "description": "Link to a public text or CSV file with one URL, item id or keyword per line." }, "sortBy": { "title": "Sort by", "enum": [ "sales", "priceAsc", "priceDesc" ], "type": "string", "description": "Order of the first result list. With Deep scan on, the other orders are read too.", "default": "sales" }, "minPrice": { "title": "Min price (CNY)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Lowest price in yuan, e.g. 20. Sent to Taobao and re-checked on every row before it is charged." }, "maxPrice": { "title": "Max price (CNY)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Highest price in yuan, e.g. 200. Sent to Taobao and re-checked on every row before it is charged." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only listings Taobao marks as shipping free (Taobao's own filter; the top-rated list is skipped because it ignores it).", "default": false }, "region": { "title": "Storefront / currency", "enum": [ "", "sg", "my", "au", "nz", "ca", "jp", "kr", "th", "ph", "vn", "mo", "kh" ], "type": "string", "description": "Empty = prices in CNY. Pick a world storefront to get `price` in its money (CNY stays in `priceCny`).", "default": "" }, "tmallOnly": { "title": "Tmall only", "type": "boolean", "description": "Only Tmall (倩猫) stores. Needs each product's item page, so it turns item-page details on (charged only for delivered rows).", "default": false }, "minDescriptionScore": { "title": "Min shop description score", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep products whose shop's \"item as described\" score (descriptionMatchScore, 1-5) is at least this, e.g. 4.7." }, "excludeKeywords": { "title": "Exclude words", "type": "array", "description": "Drop products whose title or shop name contains any of these words, e.g. \"δΊŒζ‰‹\" (second-hand).", "items": { "type": "string" } }, "includeDetails": { "title": "Item-page details", "type": "boolean", "description": "Read each product's item page: Tmall or Taobao, ship-from city, seller DSR scores and credit level, shop age, rating split, latest review, coupon link. Add-on $0.00027 per product.", "default": false }, "includeTopRated": { "title": "Add the top-rated list", "type": "boolean", "description": "Also read Taobao's top-rated list for each keyword (up to 40 products, with buyer Q&A on some).", "default": true }, "deepScan": { "title": "Deep scan", "type": "boolean", "description": "Read more result lists per keyword (other sort orders, price bands, the page's own brand and property filters) to go past the first 20. Up to ~1,000 per keyword.", "default": true }, "translateTitles": { "title": "English titles", "type": "boolean", "description": "Add `titleEn`, a machine translation of the Chinese title.", "default": true }, "translateKeywords": { "title": "Translate English keywords", "type": "boolean", "description": "When an English keyword has no Taobao page of its own, search its Chinese translation.", "default": true }, "includeShopProfiles": { "title": "Shop profile rows", "type": "boolean", "description": "With Shop IDs: also deliver one row per shop with its three DSR scores, seller id and catalogue size. $0.0013 per shop row.", "default": false }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Deliver only products not delivered by earlier runs of this input, plus products whose price changed (with the previous price). Unchanged products are skipped and not charged.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that remembers delivered products and prices. Use one name per watch list, e.g. \"taobao-phone-cases\".", "default": "taobao-monitor" }, "maxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 1500, "type": "integer", "description": "Products per keyword, category or shop. Categories give 20, shops up to 60, a keyword about 1,000 with Deep scan (one list holds 20).", "default": 100 }, "maxResults": { "title": "Max results in total", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop the whole run after this many products. 0 = no total cap.", "default": 0 }, "compact": { "title": "Compact output", "type": "boolean", "description": "Core fields only (id, title, price, shop, category, image), trimmed for AI/MCP pipelines. Add-on fields stay on rows that carry them.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: the actor uses the platform's own connection first, then Apify datacenter IPs paced to a few pages each. Residential applies to list pages only.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Item pages in parallel", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many item pages are read at once when details are on.", "default": 6 } } }, "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 } } } } } } } } } }