Tweets
Twitter broadcast API: get an X live video's details
Get one Twitter or X broadcast, a live video, by ID or URL: title, state, start and end times, watch counts, video size, and broadcaster. 1 credit per call.
- 200
- 400
- 401
- 402
- 404
- 424
- 429
- 502
- 503
GET
Twitter broadcast API: get an X live video's details
Get broadcast returns one X broadcast, the live video X hosts at
The Node.js and Python snippets build 1 row per broadcast. Each call costs 1 credit.
A refused request costs nothing.
The path is not a broadcast ID or a broadcast URL. The request costs nothing.
Missing or invalid API key. Check the
X knows no such broadcast. The request costs nothing.
The read service returned an error. Retry after a short delay.
Xquik is busy. Wait for
You exceeded your tier rate limit. Wait for the
The normalized v1 response contract can return 424 when the read service is unavailable.
x.com/i/broadcasts, live or ended.
The endpoint is GET /api/v1/x/broadcasts/{id}.
Read a broadcast’s state, times, and audience
UseGET /x/broadcasts/{id} when you hold a broadcast ID or a broadcast URL.
A broadcast is an X live video. For an audio Space, use
Get Space.
statetells a broadcast that has not started from a running or ended one.scheduledStart,startedAt, andendedAtgive its times.totalWatchedcounts the accounts that watched, live or after.totalWatchingis the audience X counts now.isAvailableForReplaysays whether X offers a recording.widthandheightgive the video size in pixels.tweetis the post that announces the broadcast, with its text, counts, and author.tweetIdis its ID.creatoris the broadcaster’s full profile.periscopeUsernames the same account as X’s live video service does.
Path parameters
string
required
X broadcast ID, or the URL-encoded broadcast URL, such as
x.com/i/broadcasts/1nGeLMWbkpaKX.Headers
string
Full account key. Sessions and OAuth also work.
string
Bearer xq_your_guest_key_here authenticates paid_reads guest keys. Direct MPP uses the Payment ... credential. Get it from the WWW-Authenticate: Payment challenge.Response
200 OK
object
The broadcast.
Broadcast object fields.
string
Broadcast ID.
string
Broadcast title.
boolean
Whether the broadcaster edited the title of the replay.
string
State as X names it, such as
NotStarted, Running, or Ended.string
When the broadcast was set to start, in UTC.
string
When the broadcast went live, in UTC.
string
When the broadcast ended, in UTC.
string
When the video stream last reached X, in UTC.
number
Accounts that watched, live or after.
number
Accounts watching, as X counts them.
boolean
Whether X offers a recording of the broadcast.
number
Video width in pixels.
number
Video height in pixels.
number
Camera rotation in degrees, 0 to 359.
boolean
Whether the video stream runs in high-latency mode.
number
X’s code for who may chat.
boolean
Whether X marks the chat private.
string
What produced the video stream, as X names it, such as
LiveCms.string
X’s media key for the video.
string
Image X shows before the broadcast starts.
number
X’s revision number of the broadcast.
string
ID of the post that announces the broadcast.
object
The post that announces the broadcast, with the fields of Get Tweet.
Present only when X names the post.
object
The broadcaster as X’s live video service names the account:
id, username, displayName, and
profilePicture.400 Invalid broadcast ID
401 Unauthenticated
x-api-key header value.
402 Payment required
Account keys get account options. Guest keys get guest top-up only. Anonymous calls receive a direct MPPWWW-Authenticate: Payment challenge plus a guest wallet creation action.
No checkout starts automatically. Confirm any payment action.
404 Broadcast not found
502 X API unavailable
503 Service busy
Retry-After, then retry. The request costs nothing.
429 Rate limit exceeded
Retry-After header before retrying.
424 Dependency failed
Twitter broadcast API questions
How do I get a Twitter broadcast by its link?
URL-encode the broadcast link and pass it asid, or pass the ID from the
link. x.com/i/broadcasts/1nGeLMWbkpaKX holds the ID 1nGeLMWbkpaKX.
How many people watched a broadcast?
ReadtotalWatched for everyone who watched, live or after. totalWatching is
the audience X counts now.