tiktok

User › Live

Returns a TikTok account's live room in the platform's own shape: cover image, title, start time, status code, viewer and entry counts, stream ids, and the host's profile.

Use it to read a creator's live room state, but check status and start time yourself, since a room may still be returned after the broadcast has ended.

10 credits per call.

get/v1/tiktok/user/live

Request

  • Base URL: https://api.insightsocial.app
  • URL: https://api.insightsocial.app/v1/tiktok/user/live
  • Auth: API key in header x-api-key

Query parameters

handlestring required
Example:charlidamelio

TikTok username without the @ symbol

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Response

Success.

successtrue required
platformstring required
endpointstring required
schema_version'2' required
dataConventionsData required
unavailablestring[] required
credits_usedinteger required
credits_remaininginteger required
request_idstring required
cachedboolean required
idempotent_replayboolean required
charge_reasonstring required
free_callboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.