{ "openapi": "3.0.1", "info": { "title": "Douyin Product Search Scraper β€” Price, Sales & SKUs", "description": "Scrape Douyin Shop (Douyin Mall, jinritemai) products by keyword with price, monthly sales, positive-review rate, shop and creator commission rate. Also gets product details, SKU variant prices, buyer comments with the variant bought, and full shop catalogs. Export JSON, CSV or Excel.", "version": "1.0", "x-build-id": "YI31PPnvblYFo77YW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~douyin-product-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-douyin-product-search-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/sian.agency~douyin-product-search-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-douyin-product-search-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/sian.agency~douyin-product-search-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-douyin-product-search-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", "required": [ "operation" ], "properties": { "operation": { "title": "🎯 Operation", "enum": [ "searchProducts", "productDetail", "productSkus", "productComments", "shopProducts" ], "type": "string", "description": "One operation per run.\n\n- **πŸ” Search Products** (Keyword): 30 products a page with price, monthly sales, review score, shop and commission\n- **πŸ“¦ Product Detail** (Product ID): gallery, lifetime sales, review score\n- **🏷️ Product SKUs** (Product ID): every variant with its price\n- **πŸ’¬ Product Comments** (Product ID): 20 a page, with the variant bought and price paid\n- **πŸͺ Shop Products** (Shop ID): 10 products a page", "default": "searchProducts" }, "keyword": { "title": "πŸ” Search Keyword", "type": "string", "description": "Used by **Search Products** only. Any search term a Douyin shopper would type. Chinese terms match far more listings than English ones, for example `θΏεŠ¨ιž‹` (sneakers), `咖啑豆` (coffee beans) or `ζ‰‹ζœΊε£³` (phone case).\n\nIgnored by the other operations." }, "productId": { "title": "πŸ“¦ Product ID", "pattern": "^\\s*(\\d{6,20}|https?://\\S*[?&](id|product_id|productId|item_id|itemId)=\\d{6,20}([&#]\\S*)?)\\s*$", "type": "string", "description": "Used by **Product Detail**, **Product SKUs** and **Product Comments**. The numeric Douyin product ID, for example `3781601737262105026`. Copy it from the `productId` column of a search row, or paste a haohuo.jinritemai.com product link that contains `?id=`.\n\nIgnored by Search Products and Shop Products." }, "shopId": { "title": "πŸͺ Shop ID", "pattern": "^\\s*(\\d{6,20}|https?://\\S*[?&](shop_id|shopId|id)=\\d{6,20}([&#]\\S*)?)\\s*$", "type": "string", "description": "Used by **Shop Products** only. The numeric Douyin shop ID, for example `164753456`. Copy it from the `shopId` column of a search or SKU row.\n\nIgnored by the other operations." }, "maxPages": { "title": "πŸ“„ Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many pages to fetch for **Search Products** (up to 30 products a page), **Product Comments** (20 a page) and **Shop Products** (10 a page). The run stops sooner when Douyin has nothing new to show, and deeper search pages are not always available, so a search can stop after the first page. Product Detail and Product SKUs always return one row.\n\nStart with 1 to 3 pages to preview. Maximum 50.", "default": 5 } } }, "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 } } } } } } } } } }