{ "openapi": "3.0.1", "info": { "title": "Taobao & Tmall Scraper: Product Data in English, USD Prices", "description": "Scrape Taobao (淘宝) and Tmall (天猫) by keyword, category, shop or item id. No login, no browser. Prices in CNY plus USD, EUR, GBP and 9 more currencies, seller DSR scores, ships-from city, review tags. English columns, pay per product.", "version": "0.0", "x-build-id": "crsCDSeacdSp3QhJ9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/forgedata~taobao-tmall-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-forgedata-taobao-tmall-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/forgedata~taobao-tmall-scraper/runs": { "post": { "operationId": "runs-sync-forgedata-taobao-tmall-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/forgedata~taobao-tmall-scraper/run-sync": { "post": { "operationId": "run-sync-forgedata-taobao-tmall-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 words, one per line. Chinese keywords (手機殼, 奶粉) return the most results; English works too (iphone case).", "items": { "type": "string" } }, "startUrls": { "title": "Taobao / Tmall URLs", "type": "array", "description": "Product pages (item.taobao.com, detail.tmall.com, world.taobao.com/item/...), keyword pages (world.taobao.com/product/...), category pages (world.taobao.com/category/...), shop pages (world.taobao.com/dianpu/...) or s.taobao.com search URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "itemIds": { "title": "Item IDs", "type": "array", "description": "Taobao / Tmall item ids, e.g. 1083028793486. One row per item with live price and seller details.", "items": { "type": "string" } }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "Taobao category ids, e.g. 1512 (phones). Found in the categoryId column of results or in world.taobao.com/category/.htm links.", "items": { "type": "string" } }, "shopIds": { "title": "Shop IDs", "type": "array", "description": "Taobao / Tmall shop ids, e.g. 539056969. Returns the shop's catalog (up to 60 products per shop) with the shop's seller scores.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max products per keyword / category / shop", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop collecting for a query after this many unique products.", "default": 100 }, "deepScan": { "title": "Deep scan", "type": "boolean", "description": "Taobao's crawlable catalog serves 20 products per keyword page. Deep scan asks Taobao's own search autocomplete for the related keywords buyers use (手机壳 -> 手机壳磁吸, 手机壳带支架 ...), reads each of those pages too, and dedupes. Works best with Chinese keywords.", "default": true }, "maxFacetPages": { "title": "Max related keyword pages per query", "minimum": 0, "maximum": 500, "type": "integer", "description": "Upper bound on extra keyword and category pages fetched by deep scan for one query (each adds up to 20 products).", "default": 40 }, "followRelatedKeywords": { "title": "Follow related keywords", "type": "boolean", "description": "Also fetch the related-search keywords Taobao links from each keyword page (counted toward the same query's limit).", "default": false }, "includeDetails": { "title": "Open each product page", "type": "boolean", "description": "Fetch every product's page for seller type and credit level, the three seller DSR scores, ships-from location, category path, a sample review and review tag counts, payment methods and original vs promotion price. Slower and charged per product page.", "default": false }, "region": { "title": "Storefront region", "enum": [ "", "sg", "my", "th", "vn", "ph", "kh", "mo", "au", "nz", "kr", "jp", "ca" ], "type": "string", "description": "Taobao overseas storefront to read. Global (Traditional Chinese, CNY with HKD/TWD) by default.", "default": "" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Parallel requests. Lower it if you see many retries.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxies work well for this site and are the default. Choose residential only if you see persistent blocks.", "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 } } } } } } } } } }