Social Fetch
TikTok

Get TikTok live stream

Looks up a TikTok handle and returns live stream details when broadcasting, with profile fields for lookup context.

Operation

GET/v1/tiktok/profiles/{handle}/live

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

handlestringrequired

TikTok handle to look up, with or without a leading @.

min 1 chars · max 64 chars

Response fields

data
objectrequired

Endpoint-specific response payload.

datalookupStatus
stringrequired

Whether a TikTok profile identity could be resolved for the handle.

one of: found, not_found

dataliveStatus
stringrequirednullable

When `lookupStatus` is `found`, whether the profile is `live` or `offline`. Null when the profile could not be resolved.

one of: live, offline, null

dataprofile
objectrequirednullable

Profile identity when the lookup resolved.

dataprofileplatform
stringrequired

Social platform for this profile.

one of: tiktok

dataprofilehandle
stringrequired

TikTok username without the leading @.

dataprofiledisplayName
stringrequirednullable

Public display name shown on the TikTok profile.

dataprofileavatarUrl
stringrequirednullable

Best available avatar image URL for the profile.

dataprofileverified
booleanrequired

Whether TikTok marks the profile as verified.

dataprofileprofileUrl
stringrequired

Canonical public TikTok profile URL.

min 1 chars

dataprofileplatformUserId
string

TikTok numeric user id as a string (stable within TikTok).

dataprofilesecUid
string

TikTok opaque stable user identifier (for advanced integrations).

dataprofilefollowerCount
integer

Follower count reported by TikTok when available.

≥ 0

dataprofilefollowingCount
integer

Following count reported by TikTok when available.

≥ 0

dataprofilebio
stringnullable

Profile biography text when TikTok provides it.

datalive
objectrequirednullable

Live broadcast details when `liveStatus` is `live`. Null when not live or when the profile could not be resolved.

dataliveroomId
stringrequired

TikTok live room identifier for the current broadcast.

min 1 chars

datalivetitle
stringrequirednullable

Live stream title when TikTok provides one.

datalivecoverUrl
stringrequirednullable

Cover image URL for the live stream when available.

datalivestartedAt
stringrequirednullable

ISO-8601 timestamp when the live stream started, when TikTok provides a valid start time.

dataliveviewerCount
integerrequired

Approximate concurrent viewers reported by TikTok.

≥ 0

dataliveenterCount
integerrequired

Cumulative enters reported by TikTok for this live room.

≥ 0

datalivestreamId
string

TikTok stream identifier when TikTok provides one.

datalivestreams
arrayrequired

Flattened playback variants for the live stream.

datalivestreams[]codecFamily
stringrequired

Video codec family for this variant.

one of: h264, h265

datalivestreams[]source
stringrequired

Which upstream stream bundle this variant came from (standard vs alternate encoding).

one of: primary, hevc

datalivestreams[]qualityKey
stringrequired

Stable quality key for this variant (for example origin, hd, sd).

min 1 chars

datalivestreams[]qualityLabel
string

Human-readable quality label when TikTok provides one.

datalivestreams[]flvUrl
string

FLV playback URL when TikTok provides one.

datalivestreams[]hlsUrl
string

HLS playback URL when TikTok provides one.

datalivestreams[]cmafUrl
string

CMAF playback URL when TikTok provides one.

datalivestreams[]resolution
string

Video resolution string when TikTok reports it.

datalivestreams[]bitrate
integer

Target bitrate in bits per second when TikTok reports it.

≥ 0

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

Lookup result. Check `data.lookupStatus` for `found` or `not_found`; when found, `data.liveStatus` is `live` or `offline`, with profile context in `data.profile` and live stream payload in `data.live` when broadcasting.

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page