{ "openapi": "3.0.1", "info": { "title": "TikTok Discover Scraper: Live Stream Finder", "description": "TikTok Discover Scraper ā€” Find TikTok LIVE streams through Discover and extract stream titles, creators, viewer counts, likes, categories, timestamps, and profile details. Discover trending live content, monitor creators, and analyze real-time audience engagement.", "version": "0.1", "x-build-id": "Y7obusykCyJtqejhW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~tiktok-discover-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-tiktok-discover-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/scrapio~tiktok-discover-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-tiktok-discover-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/scrapio~tiktok-discover-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-tiktok-discover-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": [ "startUrls" ], "properties": { "startUrls": { "title": "šŸ“” Topics to scan for live rooms", "type": "array", "description": "Broad topics work best ā€” `gaming`, `chat`, `makeup`, `cooking`, `music`, `art`.\n\nAccepted per line:\nā€¢ a plain topic ā€” `gaming`\nā€¢ a hashtag ā€” `#fitness` (the `#` is stripped)\nā€¢ a handle ā€” `@charlidamelio` (the `@` is stripped, then searched as text)\nā€¢ a TikTok search URL ā€” `https://www.tiktok.com/search/live?q=gaming`\n\nVolume is small by design: TikTok serves 1-16 live rooms per term on a single page.", "items": { "type": "string" } }, "liveOnly": { "title": "šŸŽÆ Live rooms only ā€” skip the video feed", "type": "boolean", "description": "**On** ā€” only rooms that are broadcasting right now. Fastest and cheapest path: no browser is launched at all.\n\n**Off (default)** ā€” you also get the matching recorded videos for each topic, so the dataset carries the full video field set as well.", "default": false }, "minLiveViewers": { "title": "šŸ‘€ Minimum viewers in the room", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop rooms with fewer than this many people watching at the moment of the scrape.\n\n`0` keeps everything. Observed range across a sample of 50 rooms: **5 to 8,837** concurrent viewers. Try `100` to skip near-empty rooms.", "default": 0 }, "maxLiveRoomsPerTerm": { "title": "šŸ§® Cap live rooms kept per topic", "minimum": 1, "maximum": 50, "type": "integer", "description": "Hard cap on live rows per topic, so a busy term cannot surprise you on cost.\n\nThe LIVE surface returns a **single page** ā€” paging past it was measured returning 0 rooms ā€” so in practice a topic yields 1-16 rooms and this cap only binds when you set it low.", "default": 25 }, "maxItems": { "title": "šŸŽžļø Max videos per topic", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many recorded videos to collect for each topic alongside the live rooms.\n\n`0` means unlimited within platform limits (expands to 500). Anonymous search runs dry at roughly 60-200 videos per term.", "default": 10 }, "proxyConfiguration": { "title": "šŸ›°ļø Apify Proxy", "type": "object", "description": "Switch on **Use Apify Proxy** and pick groups to pin the exit IP. Note that the live-room result set follows the exit IP's region." } } }, "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 } } } } } } } } } }