← API Store
Social
TikTok
TikTok
TikTok live room
GET /tiktok/v1/liveEvery response includes credits_used: the credits this call cost.
A live room by room_id, or the current room of username. An account that is not live answers live: false.
Each call costs 1 credits; failed calls are free. Run it in the console playground to see a live result.
Parameters
| Name | Type | Description |
|---|---|---|
username | string | Example: tiktok |
room_id | string | Live room ID (instead of username). |
Every endpoint also takes: raw、fields、fresh、output、records
{
"cached": false,
"cover": "https://p16-webcast.tiktokcdn.com/webcast-va/2d40841fa55af281b3c825908f04ebc1.jpg~tplv-obj.image",
"credits_used": 1,
"flv": "https://pull-f5-tt01.fcdn.eu.tiktokcdn.com/activity/stream-3578977276417803190.flv?expire=1793994378&session_id=056-202610231946185C5EDBF59E…",
"hashtag": null,
"hls": "https://pull-hls-f16-tt01.tiktokcdn-eu.com/activity/stream-3578977276417803190/index.m3u8?expire=1793994378&session_id=056-202610231946185C5…",
"likes": 0,
"live": false,
"owner": {
"followers": 96414365,
"id": "107955",
"nickname": "TikTok",
"username": "tiktok"
},
"owner_info": {
"allow_find_by_contacts": false,
"allow_others_download_video": false,
"allow_others_download_when_sharing_video": false,
"allow_share_show_profile": false,
"allow_show_in_gossip": false,
"allow_show_my_action": false,
"allow_strange_comment": false,
"allow_unfollower_comment": false,
"allow_use_linkmic": false,
"authentication_info": {
"authentication_badge": {
"avg_color": "",
"height": 0,
"image_type": 0,
"is_animated": false,
"open_web_url": "",
"uri": "webcast-va/authentication_icon.png",
"url_list": [
"https://p16-webcast.tiktokcdn.com/webcast-va/authentication_icon.png~tplv-obj.image",
"https://p19-webcast.tiktokcdn.com/webcast-va/authentication_icon.png~tplv-obj.image"
],
"width": 0
},
"custom_verify": "",
"enterprise_verify_reason": "verified account",
"has_cert": true
},
"avatar_large": {
"avg_color": "",
"height": 0,
"image_type": 0,
"is_animated": false,
"open_web_url": "",
"uri": "1080x1080/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a",
"url_list": [
"https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:1080:1080.webp?dr=1039…",
"https://p19-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:1080:1080.webp?dr=1039…",
"… 1 more"
],
"width": 0
},
"avatar_medium": {
"avg_color": "",
"height": 0,
"image_type": 0,
"is_animated": false,
"open_web_url": "",
"uri": "720x720/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a",
"url_list": [
"https://p19-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:720:720.webp?dr=10399&…",
"https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:720:720.webp?dr=10399&…",
"… 1 more"
],
"width": 0
},
"avatar_thumb": {
"avg_color": "",
"height": 0,
"image_type": 0,
"is_animated": false,
"open_web_url": "",
"uri": "100x100/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a",
"url_list": [
"https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:100:100.webp?dr=10399&…",
"https://p19-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:100:100.webp?dr=10399&…",
"… 1 more"
],
"width": 0
},
"badge_image_list": [],
"badge_list": [],
"bg_img_url": "",
"bio_description": "Your next discovery is waiting on TikTok.",
"block_status": 0,
"border_list": [],
"comment_restrict": 0,
"commerce_webcast_config_ids": [],
"constellation": "",
"create_time": 0,
"deprecated1": 0,
"deprecated12": 0,
"deprecated13": 0,
"deprecated15": 0,
"deprecated16": false,
"deprecated17": false,
"deprecated18": "",
"deprecated19": false,
"deprecated2": 0,
"deprecated21": 0,
"deprecated28": false,
"deprecated29": "",
"deprecated3": 0,
"deprecated4": 0,
"deprecated5": "",
"deprecated6": 0,
"deprecated7": "",
"…": "54 more fields"
},
"room_id": "7693676830666705678",
"started_at": "2026-10-06T21:56:52.000Z",
"stats": {
"comment_count": 0,
"deprecated1": 0,
"deprecated2": "",
"digg_count": 0,
"enter_count": 441346,
"fan_ticket": 0,
"follow_count": 0,
"gift_uv_count": 0,
"id": 7693676830666706000,
"id_str": "7693676830666705678",
"like_count": 0,
"replay_fan_ticket": 0,
"replay_viewers": 382959,
"room_follow_count": 0,
"share_count": 0,
"total_user": 441346,
"total_user_desp": "",
"user_count_composition": {
"deprecated1": 0,
"my_follow": 0,
"other": 0,
"video_detail": 0
},
"watch_user_count": 0,
"watermelon": 0
},
"status": 4,
"stream_urls": {
"alive_timestamp": 0,
"candidate_resolution": [
"SD1",
"SD2",
"… 2 more"
],
"complete_push_urls": [],
"default_audio_track_lang": [],
"default_resolution": "HD1",
"drm_type": 0,
"extra": {
"anchor_client_info": {
"custom_info": ""
},
"anchor_interact_profile": 0,
"audience_interact_profile": 0,
"bframe_enable": false,
"bitrate_adapt_strategy": 0,
"bytevc1_enable": false,
"default_bitrate": 0,
"deprecated1": false,
"fps": 0,
"gop_sec": 0,
"hardware_encode": false,
"height": 0,
"max_bitrate": 0,
"min_bitrate": 0,
"roi": false,
"sw_roi": false,
"video_profile": 0,
"width": 0
},
"flv_pull_url": {
"FULL_HD1": "https://pull-f5-tt01.fcdn.eu.tiktokcdn.com/activity/stream-3578977276417803190_uhd.flv?expire=1793994378&sign=e7912763a5f8650ea08ada84e84a53…",
"HD1": "https://pull-f5-tt01.fcdn.eu.tiktokcdn.com/activity/stream-3578977276417803190_hd.flv?expire=1793994378&sign=9e857f70ae9b87c852bf546d502c8f1…",
"SD1": "https://pull-f5-tt01.fcdn.eu.tiktokcdn.com/activity/stream-3578977276417803190_ld.flv?expire=1793994378&sign=8492191f97780ac9f8983505548b29e…",
"SD2": "https://pull-f5-tt01.fcdn.eu.tiktokcdn.com/activity/stream-3578977276417803190_sd.flv?expire=1793994378&lsb_session_id=056-202610231946185C5…"
},
"flv_pull_url_params": {
"FULL_HD1": "{\"VCodec\":\"h264\",\"cmaf_auth\":\"auth_mode=2\\u0026expire=1793994378\\u0026sign=7a02dae02327c9256c01637e56c4bd10\",\"cdn_name\":\"fcdn\",\"stream_suffi…",
"HD1": "{\"VCodec\":\"h264\",\"cmaf_auth\":\"auth_mode=2\\u0026expire=1793994378\\u0026sign=7a02dae02327c9256c01637e56c4bd10\",\"cdn_name\":\"fcdn\",\"stream_suffi…",
"SD1": "{\"VCodec\":\"h264\",\"cmaf_auth\":\"auth_mode=2\\u0026expire=1793994378\\u0026sign=7a02dae02327c9256c01637e56c4bd10\",\"vbitrate\":600000,\"resolution\":…",
"SD2": "{\"VCodec\":\"h264\",\"cmaf_auth\":\"auth_mode=2\\u0026expire=1793994378\\u0026sign=7a02dae02327c9256c01637e56c4bd10\",\"stream_suffix\":\"sd\",\"vbitrate\"…"
},
"hls_pull_url": "https://pull-hls-f16-tt01.tiktokcdn-eu.com/activity/stream-3578977276417803190/index.m3u8?expire=1793994378&session_id=056-202610231946185C5…",
"hls_pull_url_map": {},
"hls_pull_url_params": "{\"VCodec\":\"h264\",\"cmaf_auth\":\"auth_mode=2\\u0026expire=1793994378\\u0026sign=7a02dae02327c9256c01637e56c4bd10\",\"cdn_name\":\"fcdn\",\"vbitrate\":95…",
"id": 3578977276417803300,
"id_str": "3578977276417803190",
"live_core_sdk_data": {
"pull_data": {
"options": {
"default_preview_quality": {
"…": "6 fields"
},
"default_quality": {
"…": "6 fields"
},
"forced_low_latency": false,
"max_drm_lenient_size": "",
"max_drm_lenient_size_backup": "",
"qualities": [
{
"…": "6 fields"
},
{
"…": "6 fields"
},
"… 3 more"
],
"show_quality_button": false,
"support_low_latency": false
},
"stream_data": "{\"common\":{\"session_id\":\"056-202610231946185C5EDBF59E8B1A2A4BE3\",\"room_id\":7693676830666705678,\"rule_ids\":\"{\\\"ab_version_trace\\\":null,\\\"sche…"
},
"push_data": {
"push_stream_level": 0,
"resolution_params": {},
"stream_data": ""
}
},
"media_track_enable": false,
"provider": 0,
"push_resolution": "",
"push_urls": [],
"resolution_name": {
"AUTO": "AUTO",
"FULL_HD1": "1080p",
"HD1": "720p",
"ORIGION": "Original",
"SD1": "360p",
"SD2": "540p",
"pm_mt_video_1080p60": "1080p60",
"pm_mt_video_720p60": "720p60",
"ttlive_videoQuality_option_2k": "2K"
},
"rtmp_pull_url": "https://pull-f5-tt01.fcdn.eu.tiktokcdn.com/activity/stream-3578977276417803190.flv?expire=1793994378&session_id=056-202610231946185C5EDBF59E…",
"rtmp_pull_url_params": "{\"VCodec\":\"h264\",\"cmaf_auth\":\"auth_mode=2\\u0026expire=1793994378\\u0026sign=7a02dae02327c9256c01637e56c4bd10\",\"cdn_name\":\"fcdn\",\"vbitrate\":95…",
"rtmp_push_url": "",
"rtmp_push_url_params": "",
"stream_app_id": 0,
"stream_control_type": 0,
"stream_delay_ms": 0,
"stream_language": "",
"stream_size_height": 0,
"stream_size_width": 0,
"vr_type": 0
},
"title": "Rihanna x FB LIVE",
"total_viewers": 441346,
"viewers": 0
} Response fields (215)
Field paths and types observed in the sample response; the live response is authoritative.
$ | object |
$.cached | boolean |
$.cover | string |
$.credits_used | integer |
$.flv | string |
$.hashtag | null |
$.hls | string |
$.likes | integer |
$.live | boolean |
$.owner | object |
$.owner.followers | integer |
$.owner.id | string |
$.owner.nickname | string |
$.owner.username | string |
$.owner_info | object |
$.owner_info.allow_find_by_contacts | boolean |
$.owner_info.allow_others_download_video | boolean |
$.owner_info.allow_others_download_when_sharing_video | boolean |
$.owner_info.allow_share_show_profile | boolean |
$.owner_info.allow_show_in_gossip | boolean |
$.owner_info.allow_show_my_action | boolean |
$.owner_info.allow_strange_comment | boolean |
$.owner_info.allow_unfollower_comment | boolean |
$.owner_info.allow_use_linkmic | boolean |
$.owner_info.authentication_info | object |
$.owner_info.authentication_info.authentication_badge | object |
$.owner_info.authentication_info.authentication_badge.avg_color | string |
$.owner_info.authentication_info.authentication_badge.height | integer |
$.owner_info.authentication_info.authentication_badge.image_type | integer |
$.owner_info.authentication_info.authentication_badge.is_animated | boolean |
$.owner_info.authentication_info.authentication_badge.open_web_url | string |
$.owner_info.authentication_info.authentication_badge.uri | string |
$.owner_info.authentication_info.authentication_badge.url_list | array |
$.owner_info.authentication_info.authentication_badge.url_list[] | string |
$.owner_info.authentication_info.authentication_badge.width | integer |
$.owner_info.authentication_info.custom_verify | string |
$.owner_info.authentication_info.enterprise_verify_reason | string |
$.owner_info.authentication_info.has_cert | boolean |
$.owner_info.avatar_large | object |
$.owner_info.avatar_large.avg_color | string |
$.owner_info.avatar_large.height | integer |
$.owner_info.avatar_large.image_type | integer |
$.owner_info.avatar_large.is_animated | boolean |
$.owner_info.avatar_large.open_web_url | string |
$.owner_info.avatar_large.uri | string |
$.owner_info.avatar_large.url_list | array |
$.owner_info.avatar_large.url_list[] | string |
$.owner_info.avatar_large.width | integer |
$.owner_info.avatar_medium | object |
$.owner_info.avatar_medium.avg_color | string |
$.owner_info.avatar_medium.height | integer |
$.owner_info.avatar_medium.image_type | integer |
$.owner_info.avatar_medium.is_animated | boolean |
$.owner_info.avatar_medium.open_web_url | string |
$.owner_info.avatar_medium.uri | string |
$.owner_info.avatar_medium.url_list | array |
$.owner_info.avatar_medium.url_list[] | string |
$.owner_info.avatar_medium.width | integer |
$.owner_info.avatar_thumb | object |
$.owner_info.avatar_thumb.avg_color | string |
$.owner_info.avatar_thumb.height | integer |
$.owner_info.avatar_thumb.image_type | integer |
$.owner_info.avatar_thumb.is_animated | boolean |
$.owner_info.avatar_thumb.open_web_url | string |
$.owner_info.avatar_thumb.uri | string |
$.owner_info.avatar_thumb.url_list | array |
$.owner_info.avatar_thumb.url_list[] | string |
$.owner_info.avatar_thumb.width | integer |
$.owner_info.badge_image_list | array |
$.owner_info.badge_list | array |
$.owner_info.bg_img_url | string |
$.owner_info.bio_description | string |
$.owner_info.block_status | integer |
$.owner_info.border_list | array |
$.owner_info.comment_restrict | integer |
$.owner_info.commerce_webcast_config_ids | array |
$.owner_info.constellation | string |
$.owner_info.create_time | integer |
$.owner_info.deprecated1 | integer |
$.owner_info.deprecated12 | integer |
$.owner_info.deprecated13 | integer |
$.owner_info.deprecated15 | integer |
$.owner_info.deprecated16 | boolean |
$.owner_info.deprecated17 | boolean |
$.owner_info.deprecated18 | string |
$.owner_info.deprecated19 | boolean |
$.owner_info.deprecated2 | integer |
$.owner_info.deprecated21 | integer |
$.owner_info.deprecated28 | boolean |
$.owner_info.deprecated29 | string |
$.owner_info.deprecated3 | integer |
$.owner_info.deprecated4 | integer |
$.owner_info.deprecated5 | string |
$.owner_info.deprecated6 | integer |
$.owner_info.deprecated7 | string |
$.owner_info.… | string |
$.room_id | string |
$.started_at | string |
$.stats | object |
$.stats.comment_count | integer |
$.stats.deprecated1 | integer |
$.stats.deprecated2 | string |
$.stats.digg_count | integer |
$.stats.enter_count | integer |
$.stats.fan_ticket | integer |
$.stats.follow_count | integer |
$.stats.gift_uv_count | integer |
$.stats.id | integer |
$.stats.id_str | string |
$.stats.like_count | integer |
$.stats.replay_fan_ticket | integer |
$.stats.replay_viewers | integer |
$.stats.room_follow_count | integer |
$.stats.share_count | integer |
$.stats.total_user | integer |
$.stats.total_user_desp | string |
$.stats.user_count_composition | object |
$.stats.user_count_composition.deprecated1 | integer |
$.stats.user_count_composition.my_follow | integer |
$.stats.user_count_composition.other | integer |
$.stats.user_count_composition.video_detail | integer |
$.stats.watch_user_count | integer |
$.stats.watermelon | integer |
$.status | integer |
$.stream_urls | object |
$.stream_urls.alive_timestamp | integer |
$.stream_urls.candidate_resolution | array |
$.stream_urls.candidate_resolution[] | string |
$.stream_urls.complete_push_urls | array |
$.stream_urls.default_audio_track_lang | array |
$.stream_urls.default_resolution | string |
$.stream_urls.drm_type | integer |
$.stream_urls.extra | object |
$.stream_urls.extra.anchor_client_info | object |
$.stream_urls.extra.anchor_client_info.custom_info | string |
$.stream_urls.extra.anchor_interact_profile | integer |
$.stream_urls.extra.audience_interact_profile | integer |
$.stream_urls.extra.bframe_enable | boolean |
$.stream_urls.extra.bitrate_adapt_strategy | integer |
$.stream_urls.extra.bytevc1_enable | boolean |
$.stream_urls.extra.default_bitrate | integer |
$.stream_urls.extra.deprecated1 | boolean |
$.stream_urls.extra.fps | integer |
$.stream_urls.extra.gop_sec | integer |
$.stream_urls.extra.hardware_encode | boolean |
$.stream_urls.extra.height | integer |
$.stream_urls.extra.max_bitrate | integer |
$.stream_urls.extra.min_bitrate | integer |
$.stream_urls.extra.roi | boolean |
$.stream_urls.extra.sw_roi | boolean |
$.stream_urls.extra.video_profile | integer |
$.stream_urls.extra.width | integer |
$.stream_urls.flv_pull_url | object |
$.stream_urls.flv_pull_url.FULL_HD1 | string |
$.stream_urls.flv_pull_url.HD1 | string |
$.stream_urls.flv_pull_url.SD1 | string |
$.stream_urls.flv_pull_url.SD2 | string |
$.stream_urls.flv_pull_url_params | object |
$.stream_urls.flv_pull_url_params.FULL_HD1 | string |
$.stream_urls.flv_pull_url_params.HD1 | string |
$.stream_urls.flv_pull_url_params.SD1 | string |
$.stream_urls.flv_pull_url_params.SD2 | string |
$.stream_urls.hls_pull_url | string |
$.stream_urls.hls_pull_url_map | object |
$.stream_urls.hls_pull_url_params | string |
$.stream_urls.id | integer |
$.stream_urls.id_str | string |
$.stream_urls.live_core_sdk_data | object |
$.stream_urls.live_core_sdk_data.pull_data | object |
$.stream_urls.live_core_sdk_data.pull_data.options | object |
$.stream_urls.live_core_sdk_data.pull_data.options.default_preview_quality | object |
$.stream_urls.live_core_sdk_data.pull_data.options.default_preview_quality.… | string |
$.stream_urls.live_core_sdk_data.pull_data.options.default_quality | object |
$.stream_urls.live_core_sdk_data.pull_data.options.default_quality.… | string |
$.stream_urls.live_core_sdk_data.pull_data.options.forced_low_latency | boolean |
$.stream_urls.live_core_sdk_data.pull_data.options.max_drm_lenient_size | string |
$.stream_urls.live_core_sdk_data.pull_data.options.max_drm_lenient_size_backup | string |
$.stream_urls.live_core_sdk_data.pull_data.options.qualities | array |
$.stream_urls.live_core_sdk_data.pull_data.options.qualities[] | object | string |
$.stream_urls.live_core_sdk_data.pull_data.options.qualities[].… | string |
$.stream_urls.live_core_sdk_data.pull_data.options.show_quality_button | boolean |
$.stream_urls.live_core_sdk_data.pull_data.options.support_low_latency | boolean |
$.stream_urls.live_core_sdk_data.pull_data.stream_data | string |
$.stream_urls.live_core_sdk_data.push_data | object |
$.stream_urls.live_core_sdk_data.push_data.push_stream_level | integer |
$.stream_urls.live_core_sdk_data.push_data.resolution_params | object |
$.stream_urls.live_core_sdk_data.push_data.stream_data | string |
$.stream_urls.media_track_enable | boolean |
$.stream_urls.provider | integer |
$.stream_urls.push_resolution | string |
$.stream_urls.push_urls | array |
$.stream_urls.resolution_name | object |
$.stream_urls.resolution_name.AUTO | string |
$.stream_urls.resolution_name.FULL_HD1 | string |
$.stream_urls.resolution_name.HD1 | string |
$.stream_urls.resolution_name.ORIGION | string |
$.stream_urls.resolution_name.SD1 | string |
$.stream_urls.resolution_name.SD2 | string |
$.stream_urls.resolution_name.pm_mt_video_1080p60 | string |
$.stream_urls.resolution_name.pm_mt_video_720p60 | string |
$.stream_urls.resolution_name.ttlive_videoQuality_option_2k | string |
$.stream_urls.rtmp_pull_url | string |
$.stream_urls.rtmp_pull_url_params | string |
$.stream_urls.rtmp_push_url | string |
$.stream_urls.rtmp_push_url_params | string |
$.stream_urls.stream_app_id | integer |
$.stream_urls.stream_control_type | integer |
$.stream_urls.stream_delay_ms | integer |
$.stream_urls.stream_language | string |
$.stream_urls.stream_size_height | integer |
$.stream_urls.stream_size_width | integer |
$.stream_urls.vr_type | integer |
$.title | string |
$.total_viewers | integer |
$.viewers | integer |