/v1/tiktok/user/live
Live
Checks TikTok live status and room details. 200 is_live:true/false costs 1 credit, including offline/no-stream accounts. Unavailable accounts: 404; audience controls: 403; retrieval failures: 500. Errors cost 0 credits; never infer offline.
| Credit cost | Default: 1 credit How charges are determinedCost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute. |
|---|---|
| Cache support | Not specified in the published contract. |
| Pagination | No explicit pagination metadata in the published contract. Consult the parameters and response fields below. |
Parameters
| Name | Location / required | Schema |
|---|---|---|
handleTikTok handle | query / required |
|
Request examples
Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.
cURL
curl --request GET 'https://api.fetchproof.com/v1/tiktok/user/live?handle=YOUR_HANDLE' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/tiktok/user/live?handle=YOUR_HANDLE", {
method: 'GET',
headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());Python
import os
import requests
response = requests.get("https://api.fetchproof.com/v1/tiktok/user/live?handle=YOUR_HANDLE",
headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)Responses
200Success. Envelope: success / credits_remaining / credits_charged.
application/json
object
successrequired
boolean
credits_remainingrequired
integer
credits_chargedrequired
integer
is_liverequired
boolean
liveRoomUserInforequired
object
avatarLargerrequired
string
avatarMediumrequired
string
avatarThumbrequired
string
idrequired
string
nicknamerequired
string
secUidrequired
string
secretrequired
boolean
uniqueIdrequired
string
verifiedrequired
boolean
roomIdrequired
string
signaturerequired
string
statusrequired
integer
followStatusrequired
integer
followingCountrequired
integer
followerCountrequired
integer
liveRoomrequired
object
coverUrlrequired
string
squareCoverImgrequired
string
titlerequired
string
startTimerequired
integer
statusrequired
integer
paidEventrequired
object
event_idrequired
integer
paid_typerequired
integer
liveSubOnlyrequired
integer
liveRoomModerequired
integer
hashTagIdoptional
integer
gameTagIdrequired
integer
liveRoomStatsrequired
object
enterCountrequired
integer
userCountrequired
integer
streamDatarequired
object
pull_datarequired
object
optionsrequired
object
default_qualityrequired
object
icon_typerequired
integer
levelrequired
integer
namerequired
string
resolutionrequired
string
sdk_keyrequired
string
v_codecrequired
string
qualitiesrequired
array
Array items
object
icon_typerequired
integer
levelrequired
integer
namerequired
string
resolutionrequired
string
sdk_keyrequired
string
v_codecrequired
string
show_quality_buttonrequired
boolean
default_preview_qualityoptional
object
icon_typerequired
integer
levelrequired
integer
namerequired
string
resolutionrequired
string
sdk_keyrequired
string
v_codecrequired
string
forced_low_latencyoptional
boolean
max_drm_lenient_sizeoptional
string
max_drm_lenient_size_backupoptional
string
support_low_latencyoptional
boolean
stream_datarequired
string
push_dataoptional
object
push_stream_levelrequired
integer
resolution_paramsrequired
object
stream_datarequired
string
streamIdrequired
string
multiStreamScenerequired
integer
multiStreamSourcerequired
integer
hevcStreamDatarequired
object
pull_datarequired
object
optionsrequired
object
default_qualityrequired
object
icon_typerequired
integer
levelrequired
integer
namerequired
string
resolutionrequired
string
sdk_keyrequired
string
v_codecrequired
string
qualitiesrequired
array
Array items
object
icon_typerequired
integer
levelrequired
integer
namerequired
string
resolutionrequired
string
sdk_keyrequired
string
v_codecrequired
string
show_quality_buttonrequired
boolean
default_preview_qualityoptional
object
icon_typerequired
integer
levelrequired
integer
namerequired
string
resolutionrequired
string
sdk_keyrequired
string
v_codecrequired
string
forced_low_latencyoptional
boolean
max_drm_lenient_sizeoptional
string
max_drm_lenient_size_backupoptional
string
support_low_latencyoptional
boolean
stream_datarequired
string
push_dataoptional
object
push_stream_levelrequired
integer
resolution_paramsrequired
object
stream_datarequired
string