{ "openapi": "3.0.1", "info": { "title": "TikTok LIVE Scraper — Streams, Viewers, Top Gifters & Rankings", "description": "Scrape TikTok LIVE with no login: find live streams by keyword or game, with viewers, likes, total audience and the streamer's followers. Check whether creators are live now, list each room's top gifters with coins sent, the daily creator ranking and the gift catalogue.", "version": "0.1", "x-build-id": "55HXGcVpRbyYxRinb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~tiktok-live-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~tiktok-live-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~tiktok-live-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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", "properties": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Find LIVE streams that are on right now by keyword, for example \"gaming\", \"makeup\" or a brand name. A page holds about 20 rooms.", "items": { "type": "string" } }, "maxRoomsPerQuery": { "title": "Rooms per query", "minimum": 5, "maximum": 2000, "type": "integer", "description": "Upper limit of LIVE rooms for each search query.", "default": 40 }, "region": { "title": "Region", "type": "string", "description": "Two-letter country code the search is run from, for example US, GB, DE, BR.", "default": "US" }, "categories": { "title": "Game categories", "type": "array", "description": "LIVE game categories as TikTok names them, for example Fortnite, Minecraft, Roblox, VALORANT. Each returns the rooms TikTok recommends in it (about 12). Turn on the category list to see the current names.", "items": { "type": "string" } }, "includeCategoryList": { "title": "List LIVE categories", "type": "boolean", "description": "Return the LIVE categories TikTok shows right now, each with its current number of viewers.", "default": false }, "usernames": { "title": "Creators", "type": "array", "description": "Usernames (charlidamelio, @charlidamelio), profile links or LIVE links. For each one you get a row that says whether they are LIVE now, with the room's title and viewers when they are. A username that does not exist returns a row with found: false.", "items": { "type": "string" } }, "includeTopGifters": { "title": "Include top gifters", "type": "boolean", "description": "For every LIVE room in the run, also return its top viewers by coins sent (up to 99), one row each. Rooms with fewer than 10 viewers are skipped.", "default": false }, "maxGiftersPerRoom": { "title": "Gifters per room", "minimum": 5, "maximum": 99, "type": "integer", "description": "Upper limit of gifter rows for one room.", "default": 99 }, "includeDailyRanking": { "title": "Daily creator ranking", "type": "boolean", "description": "TikTok's daily ranking of LIVE creators: the top 99 with their score.", "default": false }, "includeGiftCatalogue": { "title": "Gift catalogue", "type": "boolean", "description": "Every LIVE gift with its price in coins, about 700 rows.", "default": false }, "maxItems": { "title": "Maximum LIVE rooms in this run", "minimum": 5, "maximum": 100000, "type": "integer", "description": "The run stops collecting rooms when it reaches this number, across all queries and categories. Other row types do not count toward it.", "default": 1000 } } }, "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 } } } } } } } } } }