TikTok

Live

A live room's details: its title, whether it is live, viewers, likes and host. An ended room answers too.

GET/v1/tiktok/live1 credit

Headers

Get your API key

x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

room_id*stringrequiredquery

A live room's id: room.id from the profile live endpoint.

example: 7260668776968964907

Response fields

dataobject

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

data.idstring

The live room's id.

data.urlstring

Its host's live page's link.

data.titlestringnullable

Its title.

data.is_liveboolean

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

data.viewersintegernullable

Viewers now: 0 once it has ended.

data.likesintegernullable

Likes.

data.started_atstringnullable

When it started.

format: date-time

data.ended_atstringnullable

When it ended; null while it is live.

format: date-time

data.coverstringnullable

Its cover image's link.

data.host_idstringnullable

Its host's user id.

data.host_handlestringnullable

Its host's handle, without the @.

data.host_namestringnullable

Its host's name.

data.host_avatarstringnullable

Its host's profile picture's link.

data.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/live?room_id=7260668776968964907' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": {    "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  }}

Search suggestions

The searches TikTok suggests for what has been typed so far, usually 10. An empty list when it has none.

Profile

An account's profile: name, bio, link, location, followers, following, post count and when it joined. A protected account's profile too, with private true.