TikTok

Profile live

Whether a profile is live now, with its live room's details when it is. A private account answers LOGIN_REQUIRED.

GET/v1/tiktok/profiles/live1 credit

Headers

Get your API key

x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

handlestringoptionalquery

A TikTok handle, with or without the @. Give handle or url.

example: mrbeast

urlstringoptionalquery

A profile's link: tiktok.com/@handle, with anything after it. Give handle or url.

max 300 chars

Response fields

dataobject

The result: one object, or a list for the endpoints that return several.

data.handlestring

The profile's handle, without the @.

data.is_liveboolean

Whether they are live now.

data.roomobjectnullable

Their live room while they are live; null otherwise.

data.room.idstring

The live room's id.

data.room.urlstring

Its host's live page's link.

data.room.titlestringnullable

Its title.

data.room.is_liveboolean

Whether it is live now; false once it has ended.

data.room.viewersintegernullable

Viewers now: 0 once it has ended.

data.room.likesintegernullable

Likes.

data.room.started_atstringnullable

When it started.

format: date-time

data.room.ended_atstringnullable

When it ended; null while it is live.

format: date-time

data.room.coverstringnullable

Its cover image's link.

data.room.host_idstringnullable

Its host's user id.

data.room.host_handlestringnullable

Its host's handle, without the @.

data.room.host_namestringnullable

Its host's name.

data.room.host_avatarstringnullable

Its host's profile picture's link.

data.room.host_followersintegernullable

Its host's followers.

pageobjectnullable

Paging, for the endpoints that page; null for the others.

page.next_cursorstringnullable

Send it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.

page.has_morebooleanoptional

Whether another page follows.

default: false

metaobject

About this call.

meta.platformstring

The platform: reddit, threads, tiktok or youtube.

meta.endpointstring

The endpoint's name, such as channel_videos.

meta.paramsobject

The call's parameters, defaults included. Parameters without a value, and the cursor, are left out.

meta.request_idstring

This call's id. Quote it when you report a problem.

meta.api_versionstring

The API version that answered.

meta.fetched_atstring

When the data was fetched from the platform (UTC).

format: date-time

meta.cachedbooleanoptional

Whether it came from our cache; fetched_at says how old it is.

default: false

Code example

curl -X GET 'https://api.socialparse.dev/v1/tiktok/profiles/live?handle=mrbeast' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": {    "handle": "string",    "is_live": true,    "room": {      "id": "string",      "url": "string",      "title": "string",      "is_live": true,      "viewers": 0,      "likes": 0,      "started_at": "2019-08-24T14:15:22Z",      "ended_at": "2019-08-24T14:15:22Z",      "cover": "string",      "host_id": "string",      "host_handle": "string",      "host_name": "string",      "host_avatar": "string",      "host_followers": 0    }  },  "page": {    "next_cursor": "string",    "has_more": false  },  "meta": {    "platform": "string",    "endpoint": "string",    "params": {      "property1": "string",      "property2": "string"    },    "request_id": "string",    "api_version": "string",    "fetched_at": "2019-08-24T14:15:22Z",    "cached": false  }}

Profile playlists

A profile's playlists, 20 a page: their names and video counts. Get a playlist's videos from the playlists endpoint. A private account answers LOGIN_REQUIRED.

Video

A video or photo post: its caption, counts, author, sound, hashtags, mentions and caption tracks.