{ "openapi": "3.0.1", "info": { "title": "TikTok Live Scraper - Search, Status, Rankings & Gifters", "description": "Scrape TikTok LIVE: search live rooms by keyword, check whether creators or rooms are live right now with viewers and host stats, read the daily ranking of top live creators and the top gifters of a live room. No login or cookies needed. Export JSON, CSV or Excel.", "version": "0.1", "x-build-id": "nti40BecGEacsSOGJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clover_folktale~tiktok-live-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clover_folktale-tiktok-live-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/clover_folktale~tiktok-live-scraper/runs": { "post": { "operationId": "runs-sync-clover_folktale-tiktok-live-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/clover_folktale~tiktok-live-scraper/run-sync": { "post": { "operationId": "run-sync-clover_folktale-tiktok-live-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "liveSearch", "liveStatus", "liveRanking", "liveGifters" ], "type": "string", "description": "What to scrape: live rooms found by keyword, whether given users or rooms are live right now, the daily ranking of top live creators, or the top gifters of a live room.", "default": "liveSearch" }, "keywords": { "title": "Keywords (mode: liveSearch)", "type": "array", "description": "Search keywords; each keyword is a separate search and pays its own start fee. Falls back to \"cat\" when empty.", "items": { "type": "string" } }, "region": { "title": "Search region (mode: liveSearch)", "type": "string", "description": "Two-letter country code of the search, for example US or GB. Default US.", "default": "US" }, "users": { "title": "Users (modes: liveStatus, liveGifters)", "type": "array", "description": "TikTok handles (@name or name), profile links or live links such as https://www.tiktok.com/@name/live. Short links are not supported. In liveGifters a user must be live; each user pays its own start fee.", "items": { "type": "string" } }, "roomIds": { "title": "Live room IDs (modes: liveStatus, liveGifters)", "type": "array", "description": "Live room IDs (15 to 20 digits, the roomId of a result). liveStatus checks them in batches. In liveGifters each room pays its own start fee.", "items": { "type": "string" } }, "includeRoomInfo": { "title": "Add room data to checked rooms (mode: liveStatus)", "type": "boolean", "description": "For every live room given by ID, add title, viewers, likes, start time and host data (one more request per live room).", "default": false }, "rankDay": { "title": "Ranking day (mode: liveRanking)", "enum": [ "today", "yesterday" ], "type": "string", "description": "The ranking of today so far, or the ranking of yesterday.", "default": "today" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum records for each keyword (liveSearch) or each room (liveGifters), up to 1000; for liveStatus the maximum number of users and rooms checked; for liveRanking the maximum rows (the ranking holds 99). A room ranking holds up to 30 people, often fewer. You are charged per record returned ($0.004 live room or status, $0.002 ranking row, $0.001 gifter row), plus a $0.005 start fee per run. Keyword search and every room in liveGifters pay the start fee again.", "default": 20 } } }, "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 } } } } } } } } } }