Appearance
TikTok Live
GET /v1/tiktok/user/live
Checks if a TikTok user is currently live streaming and retrieves their live room details. Returns liveRoomUserInfo (nickname, avatar, followerCount, roomId) and liveRoom (title, startTime, status, liveRoomStats with enterCount and userCount, plus streamData with playback URLs in multiple qualities).
Authentication
All requests require the x-api-key header. Get your key at scrapecreators.com.
Query Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
handle | string | yes | TikTok handle | thejustalex |
Example Request
curl
bash
curl 'https://api.scrapecreators.com/v1/tiktok/user/live?handle=thejustalex' \
-H 'x-api-key: $SCRAPECREATORS_API_KEY'Node / TypeScript
js
const params = new URLSearchParams({ handle: 'thejustalex' });
const res = await fetch(`https://api.scrapecreators.com/v1/tiktok/user/live?${params}`, {
headers: { 'x-api-key': process.env.SCRAPECREATORS_API_KEY }
});
const data = await res.json();
console.log(data);Python
python
import os, requests
r = requests.get(
'https://api.scrapecreators.com/v1/tiktok/user/live',
headers={'x-api-key': os.environ['SCRAPECREATORS_API_KEY']},
params={'handle': 'thejustalex'},
)
r.raise_for_status()
print(r.json())CLI
bash
scrapecreators tiktok user-live --helpExample Response
json
{
"success": true,
"liveRoomUserInfo": {
"avatarLarger": "https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/b169e9223700dc8d20d327510eb47f94~tplv-tiktokx-cropcenter:1080:1080.webp?dr=9640&refresh_token=c39a7259&x-expires=1751918400&x-signature=2Q%2F13wVO%2F%2F5OFBDinwMuULyBINc%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=fdd36af4&idc=useast5",
"avatarMedium": "https://p16-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/b169e9223700dc8d20d327510eb47f94~tplv-tiktokx-cropcenter:720:720.webp?dr=9640&refresh_token=7da1901a&x-expires=1751918400&x-signature=WDVM4wsOBsWKV04aQNYqBRnllxQ%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=fdd36af4&idc=useast5",
"avatarThumb": "https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/b169e9223700dc8d20d327510eb47f94~tplv-tiktokx-cropcenter:100:100.webp?dr=9640&refresh_token=baf34a19&x-expires=1751918400&x-signature=fWClWNGmv23Nggnk7gE17yC3D78%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=5be10d83&idc=useast5",
"id": "6742945285876515845",
"nickname": "JustAlex",
"secUid": "MS4wLjABAAAA3_8rhYkKsHyYO45EzOF7RBQJRs1EaHBqHFtYIaz3aka44bMVgCLONvFaXPkddJei",
"secret": false,
"uniqueId": "thejustalex",
"verified": false,
"roomId": "7523685855395842871",
"signature": "🔴LIVE EVERYDAY🔴\n-\n📧rainzbizemail@gmail.com📧\nSocials 👇",
"status": 2,
"followStatus": 0,
"followingCount": 1225,
"followerCount": 601562
},
"liveRoom": {
"coverUrl": "https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/b169e9223700dc8d20d327510eb47f94~tplv-tiktokx-cropcenter:720:720.webp?dr=9640&refresh_token=524467bc&x-expires=1751918400&x-signature=dYrBW7UodqMDScfs4YMnmfK24Zg%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=fdd36af4&idc=useast5",
"squareCoverImg": "https://p16-webcast.tiktokcdn-us.com/webcast-oci-tx/98159d71f96ce0a13c8234c485082e14~tplv-obj.image",
"title": "6'13 Grateful Streamer",
"startTime": 1751744708,
"status": 2,
"paidEvent": {
"event_id": 0,
"paid_type": 0
},
"liveSubOnly": 0,
"liveRoomMode": 6,
"hashTagId": 5,
"gameTagId": 1983,
"liveRoomStats": {
"enterCount": 30960,
"userCount": 804
},
"streamData": {
"pull_data": {
"options": {
"default_quality": {
"icon_type": 0,
"level": 0,
"name": "540p",
"resolution": "",
"sdk_key": "sd",
"v_codec": ""
},
"qualities": [
{
"icon_type": 6,
"level": 10,
"name": "Original",
"resolution": "",
"sdk_key": "origin",
"v_codec": ""
}
],
"show_quality_button": false
},
"stream_data": "{\"common\":{\"session_id\":\"173-20250705204222D51B254BA2C5D264202E\",\"rule_ids\":\"{\\\"ab_version_trace\\\":null,\\\"sched\\\":\\\"{\\\\\\\"ids\\\\\\\":[\\\\\\\"ex_8350
... (truncated)Credits
Most ScrapeCreators endpoints consume 1 credit per successful response. Some heavier endpoints (transcripts, AI-driven enrichment, ad detail lookups) may cost more. Check GET /v1/credit-balance for your remaining balance.
Errors
| Status | Meaning | Action |
|---|---|---|
| 200 | Success. | Use the JSON payload. |
| 400 | Invalid or missing parameter. | Verify required parameters and value format. |
| 401 | Missing or invalid x-api-key. | Pass a valid API key in the header. |
| 402 | Out of credits. | Top up at scrapecreators.com or wait for plan reset. |
| 404 | Resource not found or private. | Confirm the handle, URL, or id and that the resource is public. |
| 429 | Rate limited. | Backoff and retry with exponential delay. |
| 500 | Server error or upstream platform failure. | Retry with backoff; report persistent errors to support. |