- Cost
- 1 credit
- Cached repeats
- Nonealways fetched live
- Failed requests
- 0 credits
You send handle.
Part of the TikTok Scraper API: 24 TikTok endpoints on one key.
Request
Send your key in the x-api-key header.
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 timeout=60,12)13body = res.json()1415if body["ok"]:16 print(body["data"])17else:18 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}Parameters
| Name | Type | Required | Description |
|---|---|---|---|
handle | string | yes | Username, with or without the leading @. Also accepted as username. |
Every request also accepts trim, raw and max_age_days.
Response
Sample from a recorded response, shortened. Values are examples, not your data.
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...",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}Fields
One LiveStream in data.
A field the platform does not give is null, never made up. Extra platform details are in extra.
| Field | Type | Always | Notes |
|---|---|---|---|
object | "live_stream" | ||
platform | Platform | yes | |
is_live | boolean | yes | |
id | string or null | room / stream id | |
url | string or null | ||
author | Author or null | ||
title | string or null | ||
viewer_count | integer or null | ||
like_count | integer or null | ||
started_at | string (ISO 8601 date-time) or null | ||
cover_url | string or null | ||
extra | object or null |
Full field list in the reference for this endpoint and the data models. Errors are listed under Errors.
Questions
Which errors can it return?
invalid_params (do not retry), not_found (do not retry). Account and platform errors from the errors list can also happen. A failure always costs 0 credits.
Is there an SDK call for it?
The Python client has client.tiktok.profile_live(...) and the TypeScript client client.tiktok.profileLive(). Both return the same envelope as the HTTP API. Install them from PyPI (socialscrape-sdk) or npm (socialscrape); plain HTTP works in any language.
Can an AI agent call it?
Yes. The MCP server, which you run on your own machine, reaches every built endpoint, with the same prices.