{ "openapi": "3.0.1", "info": { "title": "Douyin Trending Live Rooms Scraper", "description": "Discover live rooms on Douyin (Chinese TikTok) by category: hot, chat, music, games, dance, and more. Get live viewer counts, streamer profiles, follower counts, cover images, and stream URLs. No login needed.", "version": "0.1", "x-build-id": "xnn7jvEYC2rokpFWG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hgservices~douyin-trending-live-rooms-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hgservices-douyin-trending-live-rooms-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/hgservices~douyin-trending-live-rooms-scraper/runs": { "post": { "operationId": "runs-sync-hgservices-douyin-trending-live-rooms-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/hgservices~douyin-trending-live-rooms-scraper/run-sync": { "post": { "operationId": "run-sync-hgservices-douyin-trending-live-rooms-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": { "categories": { "title": "Categories", "type": "array", "description": "Live categories to browse. Leave empty to scrape every category that Douyin shows now, including new ones. Game titles (for example Honor of Kings) are subcategories of Games.", "items": { "type": "string", "enum": [ "720", "101", "102", "103", "104", "105", "106", "107", "108", "1011032", "1010045", "1010017", "1010014", "1010032", "1010042", "1010026", "1010055" ], "enumTitles": [ "Hot (热门)", "Chat (聊天)", "Music (音乐)", "Games (游戏)", "Anime (ACG) (二次元)", "Dance (舞蹈)", "Culture (文化)", "Lifestyle (生活)", "Sports (运动)", "Games › Delta Force (三角洲行动)", "Games › Honor of Kings (王者荣耀)", "Games › Valorant (无畏契约)", "Games › League of Legends (英雄联盟)", "Games › Peacekeeper Elite (和平精英)", "Games › Naruto Mobile (火影忍者手游)", "Games › PUBG (绝地求生)", "Games › Golden Spatula (TFT) (金铲铲之战)" ] }, "default": [] }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many rooms are saved. Set 0 for no limit.", "default": 0 }, "minViewers": { "title": "Minimum live viewers", "minimum": 0, "type": "integer", "description": "Skip rooms with fewer live viewers than this number. Many rooms have fewer than 5 viewers.", "default": 0 }, "includeStreamUrls": { "title": "Include stream URLs", "type": "boolean", "description": "Add the FLV and HLS stream URLs for each quality. These URLs expire after some time.", "default": true }, "deduplicate": { "title": "Remove duplicate rooms", "type": "boolean", "description": "Save each room once, even when it shows in more than one category (for example Games and Honor of Kings).", "default": false } } }, "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 } } } } } } } } } }