Is a TikTok user live API

Whether the user is live now, with the room's details when they are.

GET /v1/tiktok/profile/live

Whether the user is live now, with the room's details when they are.

Cost: 1 credit
Cache: Not cached.
Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

Name	Type	Required	Description
`handle`	string	yes	Username, with or without the leading @. Also accepted as `username`.

Every request also accepts:

trim: true for a smaller response without null fields and extra.
raw: true to also get the platform's original object as raw.
max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

1curl -G "https://api.socialscrape.dev/v1/tiktok/profile/live" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "handle=khaby.lame"

1import os2import requests34params = {5    "handle": "khaby.lame",6}7res = requests.get(8    "https://api.socialscrape.dev/v1/tiktok/profile/live",9    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},10    params=params,11)12body = res.json()1314if body["ok"]:15    print(body["data"])16else:17    print(body["error"]["code"], body["error"]["message"])

1const url = new URL("https://api.socialscrape.dev/v1/tiktok/profile/live");2url.search = new URLSearchParams({3  "handle": "khaby.lame"4}).toString();5const res = await fetch(url, {6  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },7});8const body = await res.json();910if (body.ok) {11  console.log(body.data);12} else {13  console.error(body.error.code, body.error.message);14}

1{2  "nodes": [3    {4      "name": "SocialScrape Is a TikTok user live",5      "type": "n8n-nodes-base.httpRequest",6      "typeVersion": 4.2,7      "position": [8        0,9        010      ],11      "parameters": {12        "method": "GET",13        "url": "https://api.socialscrape.dev/v1/tiktok/profile/live",14        "sendQuery": true,15        "queryParameters": {16          "parameters": [17            {18              "name": "handle",19              "value": "khaby.lame"20            }21          ]22        },23        "sendHeaders": true,24        "headerParameters": {25          "parameters": [26            {27              "name": "x-api-key",28              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"29            }30          ]31        }32      }33    }34  ],35  "connections": {}36}

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

200 OKSample response

1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_2ed53439a70e8af86fc87135",8  "data": {9    "object": "live_stream",10    "platform": "tiktok",11    "is_live": false,12    "id": null,13    "url": "https://www.tiktok.com/@khaby.lame/live",14    "author": {15      "id": "127905465618821121",16      "handle": "khaby.lame",17      "name": "Khabane lame",18      "url": "https://www.tiktok.com/@khaby.lame",19      "avatar_url": "https://p16-common-sign.tiktokcdn-us.com/tos-useast8-avt-0068-tx2/08987e23b94057953fd4f1738694bf5f~tplv-tiktokx-cropcenter:100:100.jpeg?dr=9640&refresh_token=885a0b6a&x-expires=1793498400&x-signature=t%2FpvSkpSuAykwAvMSCu5rE%2F1ZDg%3D&t=4d5...",20      "verified": true21    },22    "title": null,23    "viewer_count": null,24    "like_count": null,25    "started_at": null,26    "cover_url": null,27    "extra": null28  },29  "cursor": null,30  "has_more": null31}

Response#

A LiveStream object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

Code	HTTP	Retry	Meaning
`invalid_params`	400	no	A parameter is missing, unknown or has the wrong type.
`not_found`	404	no	The platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Also served at#

These paths answer the same request, so code written for other APIs keeps working: /v1/tiktok/user/live. See Switching from ScrapeCreators.

TikTok profile (GET /v1/tiktok/profile)
TikTok profile videos (GET /v1/tiktok/profile/videos)
TikTok collection videos (GET /v1/tiktok/collection/videos)
TikTok video details (GET /v1/tiktok/video)
TikTok video transcript (GET /v1/tiktok/video/transcript)
TikTok video comments (GET /v1/tiktok/video/comments)
TikTok comment replies (GET /v1/tiktok/video/comment/replies)
TikTok user search (GET /v1/tiktok/search/users)