Douyin User live API
Check by user_id (a secUid or a profile link) whether a host is live right now. When is_live is true, the object adds room_id, live_id, title, viewer_count and streams, for $0.79 per 1,000 calls.
- Nicknames, Douyin IDs and short links are not accepted.
- While live,
live_idgoes straight intolive_sessionandlive_viewers. - Failed calls and empty results are not charged.
API health
- 24h health
- Normal
- Healthy / normal
- Available
- Limited
- Mostly down
Last 24 hours
Last 30 days
1Request
POST /api/v1/social { "platform": "douyin", "action": "user_live", "params": { "user_id": "https://www.douyin.com/user/MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS" } }2JSON response
{ "results": { "author_name": "木•••语", "is_live": false, "author_id": "MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS", "author_is_verified": false, … } }3Fields
author_name is_live author_id author_is_verified 木•••语 false MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS false 4CSV
douyin-user_live-sample.csv room_id,live_id,title,is_live,url,cover_image_url,author_name,author_id,author_douyin_id,author_avatar_url,author_is_verified,like_count,viewer_count,started_at,streams,platform,author_uid,author_follower_count,is_paid
user_id goes in, and one JSON object comes back with fields such as is_live and author_name, plus room_id and live_id while live, listed as a field table and a CSV file.What data you get
The table shows a real call for douyin.com/user/MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS, captured November 21, 2026 at 07:17 (UTC), that returned one object; gray bars mark removed personal information (••• in the CSV). Your own calls return these fields as listed in the field reference.
| room_id | live_id | title | is_live | url | cover_image_url | author_name | author_id | author_douyin_id | author_avatar_url | author_is_verified | like_count | viewer_count | started_at | streams | platform | author_uid | author_follower_count | is_paid |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
null | null | null | false | null | null | 木•••语 | MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS | false | null | null | null | null | douyin | null | null |
Use cases
Detect when a host goes live
Read
is_liveat a fixed interval, and when it turns true, notestarted_atandtitle.Find the room that is on air
When
is_liveis true, readroom_idand pass it tolive_roomfor the room state.Link to the session and the viewer list
Pass
live_idtolive_sessionfor the session details and tolive_viewersfor the viewer list.Confirm the host account
When the host is not live, the object still carries author fields such as
author_name,author_idandauthor_douyin_id, so you can confirm the account is the one you meant.
Douyin Open Platform vs EveryInfra
Here is how the Douyin Open Platform documentation for the live room status component and EveryInfra user_live compare on which account and the access you need.
| Compared | Douyin Open Platform | EveryInfra |
|---|---|---|
| Which account | For the aweme-id parameter, the documentation says only brand accounts and partner accounts bound to the mini program are supported. | user_id takes a Douyin user's secUid (starting with MS4w) or a profile link https://www.douyin.com/user/<secUid>. The account does not need to be bound to a mini program. |
| Access | The documentation says developers must first apply, in the developer console, for the live breathing-light component capability for the Douyin account. | No capability to apply for: the request holds only your EveryInfra API key and user_id. |
The Douyin Open Platform documentation is in Chinese. The table shows a translation, checked against the page on 2026-11-22. The page shows no update date. Official sources: aweme-data live room status component
Limits and gotchas
user_idis required. Pass a Douyin user's secUid (starting with MS4w) or a profile linkhttps://www.douyin.com/user/<secUid>. Nicknames, Douyin IDs and short links are not accepted.- Only when
is_liveis true does the object carryroom_id,live_id,title,viewer_countandstreams; they are absent when the host is not live. is_liveis the state at the moment of the call. To detect a stream starting, read again at a fixed interval.streamsholds signed stream addresses that expire.is_paidis true when the session is a paid live stream.- One call checks one host and returns one object.
Pricing
You pay $0.000792 per call, not per field, and one call checks one host. Failed calls and empty results are not charged.
| Calls | Cost |
|---|---|
| 10,000 | $7.92 |
| 100,000 | $79.17 |
| 1,000,000 | $791.67 |
Totals use the list price per call.
Code samples
#curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "douyin",
"action": "user_live",
"params": {
"user_id": "https://www.douyin.com/user/MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS"
}
}'OpenAPI definition (JSON)Samples read the key from the EVERYINFRA_API_KEY environment variable; copied code never contains your key.
API reference
See the parameters, response fields, errors and billing for user_live, and copy the page or open it as Markdown for an AI assistant.
AI prompt
#Please help me write a data collection script with the EveryInfra Douyin User live endpoint (douyin/user_live).
How the endpoint works:
- Request: POST https://api.everyinfra.com/api/v1/social with the header Authorization: Bearer <API key>. Read the key from the EVERYINFRA_API_KEY environment variable and never hard-code it.
- In the request body, set platform to douyin and action to user_live, and put the parameters inside params.
- Required parameters:
- user_id: The host whose live status you want: their secUid (starting MS4w) or a profile link https://www.douyin.com/user/<secUid>. Nicknames, Douyin IDs and short links are not accepted.
- Returns one object. Main fields: room_id (Live room ID (live_room): the number in…), live_id (ID of this live session (live_room)), title, is_live (Whether the account (profile, creator_s…), url, cover_image_url (Cover image URL: the cover of a video o…), author_name, author_id, author_douyin_id (The author's Douyin ID), author_avatar_url (Author avatar image URL: the creator on…), author_is_verified (Whether the author is verified (search…), like_count; 18 fields in total, full list at https://api.everyinfra.com/api/v1/social/catalog?platform=douyin.
- Example request body:
{
"platform": "douyin",
"action": "user_live",
"params": {
"user_id": "https://www.douyin.com/user/MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS"
}
}
- Price: $0.79 per 1,000 requests; failed and empty results are not charged.
- For dozens or hundreds of targets, add "mode": "async" to the body: you get a job_id at once and poll GET https://api.everyinfra.com/api/v1/jobs/{job_id} for the result.
- On 422, fix the request using the suggested parameter names and allowed values in the error; on 429 or 503, wait for Retry-After and try again.
Before writing code, ask me which targets I need, how many, which fields, and what output format I want; then confirm the plan and the rough cost with me.Request parameters
#| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
Authorization | header | string | Yes | - | Bearer followed by your API key. Create it in the console; never put it in a URL or a code repository. |
platform | body | string | Yes | douyin | Platform identifier, fixed value. |
action | body | string | Yes | user_live | Capability identifier, fixed value. |
user_id | body.params | string | Yes | - | The host whose live status you want: their secUid (starting MS4w) or a profile link https://www.douyin.com/user/<secUid>. Nicknames, Douyin IDs and short links are not accepted. |
Response example
#{ "id": "req_…", "platform": "douyin", "action": "user_live", "results": { "is_live": false, "author_name": "木•••语", "author_id": "MS4wLjABAAAAk1tZ-L085zZf2yW_H5dnVFZWyk8Rt8v4RAvf9KhTyPoVdMDxTs7Q_rvgTJGWXezS", "author_douyin_id": "•••", "author_avatar_url": "https://p3-pc.douyinpic.com/•••", "author_is_verified": false, "platform": "douyin", "author_uid": "•••" }, "billing": { "charged": …, "charged_usd": …, "balance_after_usd": …, … }, "quota": { … }}
Response fields
#Business data is in results. The table lists the fields a record can contain; values the platform does not show are never made up.
| Field | Meaning |
|---|---|
room_id | Live room ID (live_room): the number in live.douyin.com/<room_id>. |
live_id | ID of this live session (live_room); the same room gets a new one each time it goes live. |
title | Title. null when the platform has no titles (for example text-only posts). |
is_live | Whether the account (profile, creator_search) or the room (live_room) was live at the moment of the call; a point-in-time state. |
url | Link to the record on the platform. |
cover_image_url | Cover image URL: the cover of a video or image post on search, user_posts, posts_batch, related_posts, mix_posts, music_posts and media_links rows; the music cover on music_search and music_detail; the topic image on billboard_topic_hot; the collection cover on user_mixes; the room cover on live_room. Signed links expire. |
author_name | Author's display name. |
author_id | Author's unique ID on the platform. |
author_douyin_id | The author's Douyin ID. |
author_avatar_url | Author avatar image URL: the creator on search / user_posts / video / posts_batch / related_posts / mix_posts / music_posts rows, the host on live_room, the commenter on comments rows. |
author_is_verified | Whether the author is verified (search / user_posts / video / posts_batch / related_posts / mix_posts / music_posts rows; on live_room, whether the host is; on comments rows, whether the commenter is). |
like_count | Likes. null means the platform or this capability does not disclose it; it is not 0. |
viewer_count | People watching the room now (live_room); a point-in-time figure. |
started_at | When the live session started (live_room, ISO 8601, UTC); absent when not given. |
streams | Live pull URLs (live_room): [{quality, format (such as flv, hls), url}]. The URLs are signed and expire; absent when the room is not live. |
platform | Source platform identifier, the same as platform in the request (for example xiaohongshu, tiktok). |
author_uid | Numeric user ID of the author (on comments, of the commenter). author_id is the secUid; both identify the same person. |
author_follower_count | Author's follower count. null means not disclosed. |
is_paid | Keeps the platform's own meaning |
Errors and billing
#- 401
- Missing or invalid key.
- 402
- Insufficient balance. Top up first.
- 422
- Invalid parameter name or value. Fix it using the suggestions in the error. No charge.
- 429
- Per-minute request limit reached. Wait for Retry-After, then try again.
- 503
- Could not complete. The held charge is returned to your balance. If the outcome is unknown, verify it before you retry.
- 200 empty
- No data. No charge.
FAQ
What does the Douyin host live status API return?
One object: is_live, author_name, author_id, author_douyin_id, author_avatar_url, author_is_verified and author_uid; while live, also room_id, live_id, title, url, like_count, viewer_count, started_at, streams and is_paid.
What comes back when the host is not live?
is_live is false. room_id, live_id, title, viewer_count and streams are absent, and the author fields such as author_name and author_id are still there.
When do I use user_live and when live_room?
Use user_live when you hold the host's account (a secUid or profile link) and want to know whether they are live. Use live_room when you already hold the room ID (room_id).
How much does it cost to check a host?
$0.000792 per call, or $0.79 per 1,000 calls, counted by calls and not by fields. Failed calls and empty results are not charged.
Related Douyin endpoints
You can call the other Douyin endpoints with the same EveryInfra API key.
- Search
search$8.33 per 1,000 callsFind Douyin videos for a search term. - Details
profile$0.56 per 1,000 callsLook up a Douyin account by secUid. - Posts by user
user_posts$0.56 per 1,000 callsTrack the videos a Douyin account publishes, newest first. - Video details
video$0.56 per 1,000 callsFetch one Douyin video's caption, hashtags, length, engagement counts, author profile, background music and publish time from its video link, plusis_deletedandis_privatewhen Douyin reports them. - Comments
comments$0.56 per 1,000 callsPull viewer comments on a Douyin video, with likes, reply count, IP region, hot-comment and author-liked flags, mentions and any images. - Comment replies
comment_replies$0.56 per 1,000 callsList the replies under one top-level comment on a Douyin video, up to 100 per call, read 20 at a time. - Trending
trending$0.56 per 1,000 callsCheck Douyin's trending boards for hot keywords. - Transcript
transcript$0.56 per 1,000 callsTurn a Douyin video's speech into text with sentence-level timestamps. - Creator search
creator_search$0.56 per 1,000 callsSearch Douyin creator accounts by nickname, handle or phrase. - Creator audience
creator_audience$0.56 per 1,000 callsBreak down a Douyin creator's followers by device price band, gender, age or province, with each bucket's share and its TGI index. - Creator growth trend
creator_trend$0.56 per 1,000 callsTrack a Douyin creator's follower count over time as a dated series, with the average follower count across the window. - Creator benchmark
creator_benchmark$0.56 per 1,000 callsCompare a Douyin creator with similar accounts through average posts, likes, comments, shares and follower growth, each with a percentile rank. - Xingtu creator search
xingtu_creator_search$0.56 per 1,000 callsSearch Douyin's Xingtu creator records by keyword. - Xingtu creator analytics
xingtu_creator_analytics$0.56 per 1,000 callsGet a creator's Xingtu commercial profile on Douyin. - Xingtu creator rate card
xingtu_rate_card$0.56 per 1,000 callsSee the rate tiers a Douyin creator lists on Xingtu. - Xingtu creator rankings
xingtu_creator_rankings$0.56 per 1,000 callsPull up to five creators from a Douyin Xingtu ranking board. - Product search
product_search$8 per 1,000 callsSearch Douyin Mall products by keyword, up to 30 a page. - Shop store products
shop_products$8 per 1,000 callsList the products of one Douyin Mall shop from its numericshop_id, 10 a page. - Product details
product_detail$8 per 1,000 callsRead one Douyin Mall product by numeric ID. - Live product search
live_product_search$0.56 per 1,000 callsFind up to three Douyin products sold in live streams now for a keyword. - Hashtag search
hashtag_search$15.56 per 1,000 callsFind Douyin hashtags whose names contain akeyword, ranked by heat. - Hashtag detail
hashtag_detail$15.56 per 1,000 callsRead one Douyin hashtag by its numerichashtag_idfromhashtag_search. - Hot video board
billboard_video_hot$0.81 per 1,000 callsRead the video board of Hot Spot Treasure, Douyin's own trend tool: the overall board, or the boards for highest follower growth or highest like rate, over the last hour, day, 3 days or 7 days. - Low-follower hit board
billboard_low_fan_explosion$0.81 per 1,000 callsSpot Douyin works from small accounts that took off, from the low-follower hit board in Hot Spot Treasure. - High completion-rate board
billboard_high_completion$0.81 per 1,000 callsSee which Douyin works viewers watch to the end, from the high completion-rate board in Hot Spot Treasure. - Hot search board
billboard_search_hot$0.81 per 1,000 callsFind the search terms rising on Douyin, from the search board in Hot Spot Treasure. - Hot Spot account search
billboard_account_search$0.81 per 1,000 callsLook for Douyin accounts related to akeywordthrough Hot Spot Treasure, with follower, like and video counts for each. - Music search
music_search$8 per 1,000 callsSearch Douyin's music library by song title, artist or sound name. - Search suggestions
search_suggest$8 per 1,000 callsGet the autocomplete suggestions Douyin's search box shows for akeyword, in Douyin's order, withrankfrom 1. - Billboard rise list
billboard_rise_list$0.81 per 1,000 callsSpot the trends climbing fastest on Douyin, from the rising board in Hot Spot Treasure. - Billboard challenge hot
billboard_challenge_hot$0.81 per 1,000 callsRead the challenge board of Hot Spot Treasure, Douyin's own trend tool: the whole board of 50 trends in one call. - Billboard topic hot
billboard_topic_hot$0.81 per 1,000 callsSee which Douyin hashtags are heating up, from the hashtag board in Hot Spot Treasure, over the last hour, day, 3 days or 7 days. - Music detail
music_detail$0.81 per 1,000 callsRead one Douyin track by the numericmusic_idfrommusic_search, or a douyin.com/music link. - Xingtu creator conversion ability
xingtu_conversion_ability$1.6 per 1,000 callsRead the conversion figures Xingtu shows for one Douyin creator's Xingtu order videos over the last 7, 30 or 90 days: related videos, median plays, component clicks and click rate, CPC, GPM, average sales, products promoted and their categories. - Xingtu connected-user structure
xingtu_link_structure$16 per 1,000 callsSee how many users Xingtu counts as connected to one Douyin creator, split into Xingtu's four levels, each with its count, its share of the total and the median for creators in the same industry. - Xingtu recommended videos
xingtu_recommended_videos$1.6 per 1,000 callsList the four video groups on a Douyin creator's Xingtu page: signature videos, latest videos, top Xingtu order videos and top personal videos. - Xingtu connected-user sources
xingtu_touch_distribution$16 per 1,000 callsSee which content categories a Douyin creator's connected users came from, as Xingtu counts them: a tree of up to three levels, usually personal versus Xingtu content, then category and subcategory, each with a count. - Xingtu video performance
xingtu_video_performance$16 per 1,000 callsCompare a Douyin creator's personal videos and Xingtu order videos on engagement rate, median plays and completion rate. - Posts in bulk
posts_batch$0.56 per 1,000 callsLook up as many as 20 Douyin videos at once fromurls, each given as a numeric video ID, ahttps://www.douyin.com/video/<video_id>link, av.douyin.comshort link, or a whole share text that contains a short link. - Profiles in bulk
profiles_batch$0.56 per 1,000 callsLook up as many as 20 Douyin accounts at once fromurls, each given as asecUid(startingMS4w) or a profile linkhttps://www.douyin.com/user/<secUid>. - Media download links
media_links$0.56 per 1,000 callsGet download links for as many as 20 Douyin videos at once fromurls, each given as a numeric video ID or ahttps://www.douyin.com/video/<video_id>link; short links and share texts are not accepted. - Related posts
related_posts$0.56 per 1,000 callsList the videos Douyin recommends next to one video, from itsurl: a numeric video ID, ahttps://www.douyin.com/video/<video_id>link, av.douyin.comshort link or a whole share text. - Post metrics history
post_history$0.79 per 1,000 callsRead the saved history of one Douyin video'slike_count,comment_count,share_countandcollect_count. - Posts using a track
music_posts$0.79 per 1,000 callsList the videos that use one Douyin track, from itsmusic_id(taken from a video'smusic.idor frommusic_detail; a douyin.com/music link also works). - Link recognition
resolve_links$0.79 per 1,000 callsFind Douyin links and IDs inside a piece of text, such as a whole share text. - Trending history
trending_history$0.79 per 1,000 callsSee how Douyin trending terms moved over the last hours. - Account collections
user_mixes$0.79 per 1,000 callsList the collections (mixes) a Douyin account has published, from itssecUidinuser_id(aMS4wstring) or ahttps://www.douyin.com/user/<secUid>link. - Collection posts
mix_posts$0.79 per 1,000 callsList the videos in one Douyin collection from itsmix_id(taken fromuser_mixes; ahttps://www.douyin.com/collection/<ID>link also works). - Account overview
user_overview$1.6 per 1,000 callsGet a quick read on one Douyin account from itssecUidinuser_id(aMS4wstring) or ahttps://www.douyin.com/user/<secUid>link; nicknames, Douyin IDs and short links are not accepted. - Live room
live_room$0.79 per 1,000 callsRead one Douyin live room from its numericroom_id, the number inhttps://live.douyin.com/<room_id>. - News feed
feed$0.56 per 1,000 callsList the videos Douyin recommends on its home page or in one channel. - Short-drama channel
series_feed$0.56 per 1,000 callsList the short dramas on Douyin's short-drama channel, 16 per page. - Short-drama episodes
series_posts$0.79 per 1,000 callsList the episodes of one Douyin short drama from itsseries_id, in episode order, up to 20 per page. - Account short dramas
user_series$0.79 per 1,000 callsList the short dramas a Douyin account has published, from itssecUidinuser_id(aMS4wstring) or ahttps://www.douyin.com/user/<secUid>link, up to 20 per page. - On-screen video comments
danmaku$0.56 per 1,000 callsRead the on-screen comments (danmaku) of one Douyin video from itsurl: a numeric video ID, ahttps://www.douyin.com/video/<video_id>link, av.douyin.comshort link or a whole share text that contains a short link. - Broadcast viewer ranking
live_viewers$0.56 per 1,000 callsRead the viewer ranking of one Douyin broadcast from itslive_id: up to 200 viewers in one response, each withrank,user_id,douyin_id,nickname,avatar_url,is_verifiedandurl. - Short-drama details
series_detail$0.79 per 1,000 callsRead one Douyin short drama from its numericseries_id(fromseries_feedoruser_series; a share link also works). - Collection details
mix_detail$0.56 per 1,000 callsRead one Douyin collection (mix) from its numericmix_id(fromuser_mixes; ahttps://www.douyin.com/collection/<ID>link also works). - Broadcast details
live_session$0.79 per 1,000 callsRead one Douyin broadcast from itslive_id(fromlive_roomoruser_liverows; a new one each time the host goes live, not the number in the live-room link). - Profile by numeric ID
profile_by_id$0.56 per 1,000 callsLook up a Douyin account by its numericuid: theauthor_uidon video and comment rows, or theuidfromprofile.