{ "openapi": "3.0.1", "info": { "title": "Taobao Scraper", "description": "Scrape Taobao and Tmall products by keyword, category, shop or product link: title, price in yuan (plus HKD, TWD and 12 local storefront currencies), shop, photos, with optional seller scores, credit level, ratings and the latest review.", "version": "0.1", "x-build-id": "NYpc2Q1CdwfiA28gf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~taobao-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~taobao-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~taobao-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": { "searchQueries": { "title": "Search words", "type": "array", "description": "What to search Taobao for, one word or phrase per line, e.g. 手机壳, 连衣裙, phone case, lipstick. Chinese words find the most. Each search gives Taobao's top products for it (up to 40), in the storefront chosen below.", "items": { "type": "string" } }, "region": { "title": "Storefront (currency)", "enum": [ "world", "sg", "my", "th", "vn", "ph", "kh", "mo", "au", "nz", "kr", "jp", "ca" ], "type": "string", "description": "Which Taobao storefront the search words run in, e.g. Singapore for prices in SGD and simplified Chinese titles. The yuan price, plus HKD and TWD, comes with every product anyway. Categories, shops and product links always give yuan prices.", "default": "world" }, "categoryIds": { "title": "Categories", "type": "array", "description": "Taobao category ids or links, e.g. 50064014 or https://world.taobao.com/category/50064014.htm. Each gives the category's top products (up to 40).", "items": { "type": "string" } }, "shopIds": { "title": "Shops", "type": "array", "description": "Taobao shop ids or links, e.g. 188555483, https://world.taobao.com/dianpu/188555483.htm or https://shop188555483.taobao.com. Each gives the shop's listed products (up to 60) with the shop's scores. Every product row carries its shopId, so you can feed shops back here.", "items": { "type": "string" } }, "startUrls": { "title": "Product links or ids", "type": "array", "description": "Taobao or Tmall product links or item ids, e.g. https://item.taobao.com/item.htm?id=730344766230, https://detail.tmall.com/item.htm?id=1083623832870, world.taobao.com/item/... or 730344766230. Search, category and shop links work here too.", "items": { "type": "string" } }, "includeDetails": { "title": "Include seller and rating details", "type": "boolean", "description": "Open each product's page and add Taobao or Tmall, the seller (id, individual or business, credit level, shop opening date, item count, its three service scores), the rating split, the latest review, ships-from city, category path and payment methods. Slower and charged as a detailed product. Product links always come with these details.", "default": false }, "maxItems": { "title": "Max products", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Most products to save in the whole run, e.g. 100. Set 0 for no limit (every product the inputs list).", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave the default.", "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 } } } } } } } } } }