Search APIs
Loading…
← API Store
Social

TikTok

TikTok

Is a TikTok account live

GET /tiktok/v1/user/live
Test this endpoint

Every response includes credits_used: the credits this call cost.

Each call costs 1 credits; failed calls are free. Run it in the console playground to see a live result.

Parameters

NameTypeDescription
usernamerequiredstring Example: tiktok

Every endpoint also takes: raw、fields、fresh、output、records

{
  "cached": false,
  "credits_used": 1,
  "live": false,
  "room": {
    "cover": "https://p16-webcast.tiktokcdn.com/webcast-va/2d40841fa55af281b3c825908f04ebc1.jpg~tplv-obj.image",
    "hls": null,
    "likes": 382959,
    "started_at": "2026-10-06T21:56:52.000Z",
    "title": "Rihanna x FB LIVE",
    "viewers": 1
  },
  "room_id": "7693676830666705678",
  "room_status": 4,
  "stats": {
    "enterCount": 382959,
    "userCount": 1
  },
  "stream_data": {
    "pull_data": {
      "options": {
        "default_preview_quality": {
          "icon_type": 0,
          "level": 0,
          "name": "",
          "resolution": "",
          "sdk_key": "",
          "v_codec": ""
        },
        "default_quality": {
          "icon_type": 0,
          "level": 0,
          "name": "720p",
          "resolution": "",
          "sdk_key": "hd",
          "v_codec": ""
        },
        "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\":\"173-2026102319464482CD1B0868CC0E5123DF\",\"room_id\":7693676830666705678,\"rule_ids\":\"{\\\"ab_version_trace\\\":null,\\\"sche…"
    },
    "push_data": {
      "push_stream_level": 0,
      "resolution_params": {},
      "stream_data": ""
    }
  },
  "user": {
    "avatar": "https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:1080:1080.webp?dr=…",
    "avatars": {
      "larger": "https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:1080:1080.webp?dr=…",
      "medium": "https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:720:720.webp?dr=96…",
      "thumb": "https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:100:100.webp?dr=96…"
    },
    "bio_link": null,
    "commerce": null,
    "created_at": null,
    "followers": 96403393,
    "following": 1,
    "friends": null,
    "id": "107955",
    "language": null,
    "likes": null,
    "likes_given": null,
    "nickname": "TikTok",
    "organization": null,
    "private": false,
    "raw_stats": {
      "followerCount": 96403393,
      "followingCount": 1
    },
    "region": null,
    "sec_uid": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM",
    "secret": false,
    "signature": "Your next discovery is waiting on TikTok.",
    "url": "https://www.tiktok.com/@tiktok",
    "username": "tiktok",
    "verified": true,
    "videos": null
  },
  "username": "tiktok"
}
Response fields (77)

Field paths and types observed in the sample response; the live response is authoritative.

$object
$.cachedboolean
$.credits_usedinteger
$.liveboolean
$.roomobject
$.room.coverstring
$.room.hlsnull
$.room.likesinteger
$.room.started_atstring
$.room.titlestring
$.room.viewersinteger
$.room_idstring
$.room_statusinteger
$.statsobject
$.stats.enterCountinteger
$.stats.userCountinteger
$.stream_dataobject
$.stream_data.pull_dataobject
$.stream_data.pull_data.optionsobject
$.stream_data.pull_data.options.default_preview_qualityobject
$.stream_data.pull_data.options.default_preview_quality.icon_typeinteger
$.stream_data.pull_data.options.default_preview_quality.levelinteger
$.stream_data.pull_data.options.default_preview_quality.namestring
$.stream_data.pull_data.options.default_preview_quality.resolutionstring
$.stream_data.pull_data.options.default_preview_quality.sdk_keystring
$.stream_data.pull_data.options.default_preview_quality.v_codecstring
$.stream_data.pull_data.options.default_qualityobject
$.stream_data.pull_data.options.default_quality.icon_typeinteger
$.stream_data.pull_data.options.default_quality.levelinteger
$.stream_data.pull_data.options.default_quality.namestring
$.stream_data.pull_data.options.default_quality.resolutionstring
$.stream_data.pull_data.options.default_quality.sdk_keystring
$.stream_data.pull_data.options.default_quality.v_codecstring
$.stream_data.pull_data.options.forced_low_latencyboolean
$.stream_data.pull_data.options.max_drm_lenient_sizestring
$.stream_data.pull_data.options.max_drm_lenient_size_backupstring
$.stream_data.pull_data.options.qualitiesarray
$.stream_data.pull_data.options.qualities[]object | string
$.stream_data.pull_data.options.qualities[].…string
$.stream_data.pull_data.options.show_quality_buttonboolean
$.stream_data.pull_data.options.support_low_latencyboolean
$.stream_data.pull_data.stream_datastring
$.stream_data.push_dataobject
$.stream_data.push_data.push_stream_levelinteger
$.stream_data.push_data.resolution_paramsobject
$.stream_data.push_data.stream_datastring
$.userobject
$.user.avatarstring
$.user.avatarsobject
$.user.avatars.largerstring
$.user.avatars.mediumstring
$.user.avatars.thumbstring
$.user.bio_linknull
$.user.commercenull
$.user.created_atnull
$.user.followersinteger
$.user.followinginteger
$.user.friendsnull
$.user.idstring
$.user.languagenull
$.user.likesnull
$.user.likes_givennull
$.user.nicknamestring
$.user.organizationnull
$.user.privateboolean
$.user.raw_statsobject
$.user.raw_stats.followerCountinteger
$.user.raw_stats.followingCountinteger
$.user.regionnull
$.user.sec_uidstring
$.user.secretboolean
$.user.signaturestring
$.user.urlstring
$.user.usernamestring
$.user.verifiedboolean
$.user.videosnull
$.usernamestring