{ "openapi": "3.0.1", "info": { "title": "TikTok Live Status Scraper & Monitor - Go-Live Alerts, Viewers", "description": "Check whether TikTok accounts are live right now: viewer count, total enters, stream title, start time, playback URLs and follower count. Turn monitoring on and a run returns an account only when it goes live or ends a stream, for a small fee per account checked.", "version": "0.1", "x-build-id": "D4xwWzcktfkN1VoNZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~tiktok-live-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-tiktok-live-status-monitor", "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/neverempty~tiktok-live-status-monitor/runs": { "post": { "operationId": "runs-sync-neverempty-tiktok-live-status-monitor", "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/neverempty~tiktok-live-status-monitor/run-sync": { "post": { "operationId": "run-sync-neverempty-tiktok-live-status-monitor", "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": { "usernames": { "title": "TikTok usernames", "type": "array", "description": "Accounts to check: @name, name, or a profile or live URL (https://www.tiktok.com/@name/live, with or without the scheme). Names are sent in lower case, as TikTok stores them, and duplicates are checked once. If you leave this empty, the example accounts @aljazeeraenglish and @tiktok are checked and every row says so in inputUsername.", "items": { "type": "string" } }, "maxProfiles": { "title": "Maximum rows to return", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many charged rows to return in total when monitoring is off: reading stops once this many rows are ready (with onlyLive, once this many live accounts have been found), and a free row says how many entries at the end of the list were not checked. In monitoring mode it does not limit the changes returned - every change among the accounts read comes back. Up to 1,000 accounts are checked per run (about 0.7 seconds each).", "default": 100 }, "includeStreamUrls": { "title": "Include playback URLs", "type": "boolean", "description": "For accounts that are live, return the playback URLs TikTok publishes for the room (FLV / HLS / CMAF, per quality). They are signed, TikTok decides how long they work (about 14 days in URLs measured on 2026-09-14), and they do not play once the stream has ended. This Actor does not record or download anything.", "default": true }, "onlyLive": { "title": "Only return accounts that are live right now", "type": "boolean", "description": "On = accounts that are not live are checked but not returned, so they cost no row price (in monitoring mode the check fee still applies); with monitoring off, reading stops once maxProfiles live accounts have been found. Handy for a 'who is live now' list.", "default": false }, "monitoringMode": { "title": "Monitoring mode: return an account only when its live status changes", "type": "boolean", "description": "Off = every account you listed comes back with its current status, charged per row. On = the Actor remembers each account and, on later runs, returns it only when it went live, ended a stream, started a new stream, or streamed and ended between two runs. The first run returns every account once to set the baseline. **In monitoring mode every account checked costs $0.30 per 1,000 checks, changed or not** (names TikTok returns nothing for and bot checks are free), plus the row price for the rows returned. Example: 10 accounts every 5 minutes = 86,400 checks a month = $25.92. The Actor reads only as many accounts as the run's maximum total charge can pay for with a check and a change row each. The status is remembered per account; do not put the same account in two schedules that can run at the same time.", "default": false }, "resetMonitoringState": { "title": "Forget what was remembered and start over", "type": "boolean", "description": "Clears every remembered live status for this Actor, so the next monitoring run returns each account once again. This affects all your monitoring runs, because the status is stored per account rather than per list.", "default": false }, "useProxy": { "title": "Use a proxy if TikTok answers with a bot check", "type": "boolean", "description": "Every account is requested directly first, which is the fastest path and worked from Apify on every attempt measured on 2026-09-14. If TikTok answers with a bot check or an empty response, this switches to a proxy session and tries again. With it off, that answer is returned as a free 'blocked' row and no proxy is paid for.", "default": true } } }, "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 } } } } } } } } } }