Search APIs
Loading…
← API Store
Social

TikTok

TikTok

TikTok live room

GET /tiktok/v1/live
Test this endpoint

Every 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

NameTypeDescription
usernamestring Example: tiktok
room_idstringLive 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
$.cachedboolean
$.coverstring
$.credits_usedinteger
$.flvstring
$.hashtagnull
$.hlsstring
$.likesinteger
$.liveboolean
$.ownerobject
$.owner.followersinteger
$.owner.idstring
$.owner.nicknamestring
$.owner.usernamestring
$.owner_infoobject
$.owner_info.allow_find_by_contactsboolean
$.owner_info.allow_others_download_videoboolean
$.owner_info.allow_others_download_when_sharing_videoboolean
$.owner_info.allow_share_show_profileboolean
$.owner_info.allow_show_in_gossipboolean
$.owner_info.allow_show_my_actionboolean
$.owner_info.allow_strange_commentboolean
$.owner_info.allow_unfollower_commentboolean
$.owner_info.allow_use_linkmicboolean
$.owner_info.authentication_infoobject
$.owner_info.authentication_info.authentication_badgeobject
$.owner_info.authentication_info.authentication_badge.avg_colorstring
$.owner_info.authentication_info.authentication_badge.heightinteger
$.owner_info.authentication_info.authentication_badge.image_typeinteger
$.owner_info.authentication_info.authentication_badge.is_animatedboolean
$.owner_info.authentication_info.authentication_badge.open_web_urlstring
$.owner_info.authentication_info.authentication_badge.uristring
$.owner_info.authentication_info.authentication_badge.url_listarray
$.owner_info.authentication_info.authentication_badge.url_list[]string
$.owner_info.authentication_info.authentication_badge.widthinteger
$.owner_info.authentication_info.custom_verifystring
$.owner_info.authentication_info.enterprise_verify_reasonstring
$.owner_info.authentication_info.has_certboolean
$.owner_info.avatar_largeobject
$.owner_info.avatar_large.avg_colorstring
$.owner_info.avatar_large.heightinteger
$.owner_info.avatar_large.image_typeinteger
$.owner_info.avatar_large.is_animatedboolean
$.owner_info.avatar_large.open_web_urlstring
$.owner_info.avatar_large.uristring
$.owner_info.avatar_large.url_listarray
$.owner_info.avatar_large.url_list[]string
$.owner_info.avatar_large.widthinteger
$.owner_info.avatar_mediumobject
$.owner_info.avatar_medium.avg_colorstring
$.owner_info.avatar_medium.heightinteger
$.owner_info.avatar_medium.image_typeinteger
$.owner_info.avatar_medium.is_animatedboolean
$.owner_info.avatar_medium.open_web_urlstring
$.owner_info.avatar_medium.uristring
$.owner_info.avatar_medium.url_listarray
$.owner_info.avatar_medium.url_list[]string
$.owner_info.avatar_medium.widthinteger
$.owner_info.avatar_thumbobject
$.owner_info.avatar_thumb.avg_colorstring
$.owner_info.avatar_thumb.heightinteger
$.owner_info.avatar_thumb.image_typeinteger
$.owner_info.avatar_thumb.is_animatedboolean
$.owner_info.avatar_thumb.open_web_urlstring
$.owner_info.avatar_thumb.uristring
$.owner_info.avatar_thumb.url_listarray
$.owner_info.avatar_thumb.url_list[]string
$.owner_info.avatar_thumb.widthinteger
$.owner_info.badge_image_listarray
$.owner_info.badge_listarray
$.owner_info.bg_img_urlstring
$.owner_info.bio_descriptionstring
$.owner_info.block_statusinteger
$.owner_info.border_listarray
$.owner_info.comment_restrictinteger
$.owner_info.commerce_webcast_config_idsarray
$.owner_info.constellationstring
$.owner_info.create_timeinteger
$.owner_info.deprecated1integer
$.owner_info.deprecated12integer
$.owner_info.deprecated13integer
$.owner_info.deprecated15integer
$.owner_info.deprecated16boolean
$.owner_info.deprecated17boolean
$.owner_info.deprecated18string
$.owner_info.deprecated19boolean
$.owner_info.deprecated2integer
$.owner_info.deprecated21integer
$.owner_info.deprecated28boolean
$.owner_info.deprecated29string
$.owner_info.deprecated3integer
$.owner_info.deprecated4integer
$.owner_info.deprecated5string
$.owner_info.deprecated6integer
$.owner_info.deprecated7string
$.owner_info.…string
$.room_idstring
$.started_atstring
$.statsobject
$.stats.comment_countinteger
$.stats.deprecated1integer
$.stats.deprecated2string
$.stats.digg_countinteger
$.stats.enter_countinteger
$.stats.fan_ticketinteger
$.stats.follow_countinteger
$.stats.gift_uv_countinteger
$.stats.idinteger
$.stats.id_strstring
$.stats.like_countinteger
$.stats.replay_fan_ticketinteger
$.stats.replay_viewersinteger
$.stats.room_follow_countinteger
$.stats.share_countinteger
$.stats.total_userinteger
$.stats.total_user_despstring
$.stats.user_count_compositionobject
$.stats.user_count_composition.deprecated1integer
$.stats.user_count_composition.my_followinteger
$.stats.user_count_composition.otherinteger
$.stats.user_count_composition.video_detailinteger
$.stats.watch_user_countinteger
$.stats.watermeloninteger
$.statusinteger
$.stream_urlsobject
$.stream_urls.alive_timestampinteger
$.stream_urls.candidate_resolutionarray
$.stream_urls.candidate_resolution[]string
$.stream_urls.complete_push_urlsarray
$.stream_urls.default_audio_track_langarray
$.stream_urls.default_resolutionstring
$.stream_urls.drm_typeinteger
$.stream_urls.extraobject
$.stream_urls.extra.anchor_client_infoobject
$.stream_urls.extra.anchor_client_info.custom_infostring
$.stream_urls.extra.anchor_interact_profileinteger
$.stream_urls.extra.audience_interact_profileinteger
$.stream_urls.extra.bframe_enableboolean
$.stream_urls.extra.bitrate_adapt_strategyinteger
$.stream_urls.extra.bytevc1_enableboolean
$.stream_urls.extra.default_bitrateinteger
$.stream_urls.extra.deprecated1boolean
$.stream_urls.extra.fpsinteger
$.stream_urls.extra.gop_secinteger
$.stream_urls.extra.hardware_encodeboolean
$.stream_urls.extra.heightinteger
$.stream_urls.extra.max_bitrateinteger
$.stream_urls.extra.min_bitrateinteger
$.stream_urls.extra.roiboolean
$.stream_urls.extra.sw_roiboolean
$.stream_urls.extra.video_profileinteger
$.stream_urls.extra.widthinteger
$.stream_urls.flv_pull_urlobject
$.stream_urls.flv_pull_url.FULL_HD1string
$.stream_urls.flv_pull_url.HD1string
$.stream_urls.flv_pull_url.SD1string
$.stream_urls.flv_pull_url.SD2string
$.stream_urls.flv_pull_url_paramsobject
$.stream_urls.flv_pull_url_params.FULL_HD1string
$.stream_urls.flv_pull_url_params.HD1string
$.stream_urls.flv_pull_url_params.SD1string
$.stream_urls.flv_pull_url_params.SD2string
$.stream_urls.hls_pull_urlstring
$.stream_urls.hls_pull_url_mapobject
$.stream_urls.hls_pull_url_paramsstring
$.stream_urls.idinteger
$.stream_urls.id_strstring
$.stream_urls.live_core_sdk_dataobject
$.stream_urls.live_core_sdk_data.pull_dataobject
$.stream_urls.live_core_sdk_data.pull_data.optionsobject
$.stream_urls.live_core_sdk_data.pull_data.options.default_preview_qualityobject
$.stream_urls.live_core_sdk_data.pull_data.options.default_preview_quality.…string
$.stream_urls.live_core_sdk_data.pull_data.options.default_qualityobject
$.stream_urls.live_core_sdk_data.pull_data.options.default_quality.…string
$.stream_urls.live_core_sdk_data.pull_data.options.forced_low_latencyboolean
$.stream_urls.live_core_sdk_data.pull_data.options.max_drm_lenient_sizestring
$.stream_urls.live_core_sdk_data.pull_data.options.max_drm_lenient_size_backupstring
$.stream_urls.live_core_sdk_data.pull_data.options.qualitiesarray
$.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_buttonboolean
$.stream_urls.live_core_sdk_data.pull_data.options.support_low_latencyboolean
$.stream_urls.live_core_sdk_data.pull_data.stream_datastring
$.stream_urls.live_core_sdk_data.push_dataobject
$.stream_urls.live_core_sdk_data.push_data.push_stream_levelinteger
$.stream_urls.live_core_sdk_data.push_data.resolution_paramsobject
$.stream_urls.live_core_sdk_data.push_data.stream_datastring
$.stream_urls.media_track_enableboolean
$.stream_urls.providerinteger
$.stream_urls.push_resolutionstring
$.stream_urls.push_urlsarray
$.stream_urls.resolution_nameobject
$.stream_urls.resolution_name.AUTOstring
$.stream_urls.resolution_name.FULL_HD1string
$.stream_urls.resolution_name.HD1string
$.stream_urls.resolution_name.ORIGIONstring
$.stream_urls.resolution_name.SD1string
$.stream_urls.resolution_name.SD2string
$.stream_urls.resolution_name.pm_mt_video_1080p60string
$.stream_urls.resolution_name.pm_mt_video_720p60string
$.stream_urls.resolution_name.ttlive_videoQuality_option_2kstring
$.stream_urls.rtmp_pull_urlstring
$.stream_urls.rtmp_pull_url_paramsstring
$.stream_urls.rtmp_push_urlstring
$.stream_urls.rtmp_push_url_paramsstring
$.stream_urls.stream_app_idinteger
$.stream_urls.stream_control_typeinteger
$.stream_urls.stream_delay_msinteger
$.stream_urls.stream_languagestring
$.stream_urls.stream_size_heightinteger
$.stream_urls.stream_size_widthinteger
$.stream_urls.vr_typeinteger
$.titlestring
$.total_viewersinteger
$.viewersinteger