{ "openapi": "3.0.1", "info": { "title": "Taobao Keyword Suggestions Scraper - 淘宝 Autocomplete", "description": "Scrape Taobao's search-box autocomplete: the Chinese keywords real shoppers type. 100 per seed, recursive expansion (5,000 in 13s), Tmall demand counts and category IDs. No account, proxy or Chinese IP. $0.085/1,000 keywords, flat on every plan. Keywords, not products.", "version": "0.1", "x-build-id": "7vx755dbcrP0IZjLw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~taobao-keyword-suggestions-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-taobao-keyword-suggestions-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/dami_studio~taobao-keyword-suggestions-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-taobao-keyword-suggestions-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/dami_studio~taobao-keyword-suggestions-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-taobao-keyword-suggestions-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": { "seedKeywords": { "title": "Seed keywords", "type": "array", "description": "Terms to expand, one per line. Taobao's suggestion index is Chinese — 蓝牙耳机 returns 100 suggestions where \"bluetooth earphones\" returns none. Short, broad terms return the most. Each seed returns up to 100 suggestions.", "items": { "type": "string" } }, "expansionDepth": { "title": "Expansion depth", "minimum": 0, "maximum": 2, "type": "integer", "description": "0 = only ask Taobao about your seeds, which returns up to 100 keywords per seed. 1 = also ask about every suggestion that came back, roughly 100x more keywords. 2 = one level deeper again, which gets very large. Taobao has no pagination, so re-seeding is the only way to go deeper. Use the keyword cap below to control spend." }, "maxKeywords": { "title": "Maximum keywords", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on unique keywords returned across the whole run. You are charged once per unique keyword; duplicates are never charged twice." }, "includeDemandData": { "title": "Include Tmall demand counts and category IDs", "type": "boolean", "description": "Adds one extra request per seed keyword against Taobao's Tmall/B2C suggestion list, which is the only variant carrying a numeric demand count, a Taobao category ID and a relevance score. It answers for roughly half of head terms and returns nothing for most long-tail ones, so it is only asked for your seeds — never for expanded keywords." }, "includeRefinementTags": { "title": "Include refinement tags", "type": "boolean", "description": "Attaches Taobao's own attribute and brand refinement vocabulary for the parent query (style, material, brand, with its \"hot\" markers) to each row. Present for about 80% of short head terms and 13% of expanded long-tail terms. Off by default because it repeats the same list on every row of a query." }, "maxConcurrency": { "title": "Requests in flight", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many suggestion requests run at once. 1,200 requests from one address measured zero throttling, so the default is safe; lower it only if you are running through a proxy that dislikes bursts." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional and normally unnecessary. suggest.taobao.com does not rate-limit and does not require a Chinese IP, so the actor runs from its own address by default and you pay no proxy bill. Set this only if you want the traffic to leave from somewhere specific." } } }, "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 } } }, "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 } } } } } } } } } }