Get user live stream

Returns the current live stream for a user, including stream URLs and viewer count. Returns 404 if the user is not currently live.

What it does

Returns the current live stream for a user, including stream URLs and viewer count. Returns 404 if the user is not currently live.

Tool details

Field	Value
Tool name	tiktok_get_user_live
Platform	TikTok
REST endpoint	GET /v1/tiktok/users/{username}/live
Result type	Detail tool

Parameters

Parameter	Type	Required	Description
username	string	Yes	TikTok username (with or without @ symbol)
projection_preset	string	No	Defaults to minimal. Allowed values: full, minimal, identity, engagement, content.
data_fields	string[]	No	Adds top-level keys from data on top of the selected projection_preset.

Example

{
  "name": "tiktok_get_user_live",
  "arguments": {
    "username": "khaby.lame",
    "projection_preset": "minimal",
    "data_fields": [
      "entityId",
      "published",
      "content",
      "url"
    ]
  }
}

Available data fields

• @context
• type
• id
• url
• entityId
• published
• isLive
• viewCount
• viewerCount
• content
• attributedTo
• image
• attachment

Response notes

Successful calls return a JSON object with a top-level data field and, when available, metadata.creditsUsed and metadata.creditsRemaining. See response format, pagination, and credits.