Get Broadcast by ID

GET

broadcasts

{id}

Get a broadcast

curl --request GET \
  --url https://api.x.com/2/broadcasts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.x.com/2/broadcasts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.x.com/2/broadcasts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.x.com/2/broadcasts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/broadcasts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "available_for_replay": true,
    "broadcast_id": "<string>",
    "chat_option": 123,
    "created_at_ms": "<string>",
    "end_ms": "<string>",
    "height": 123,
    "id": "<string>",
    "image_url": "<string>",
    "image_url_medium": "<string>",
    "image_url_small": "<string>",
    "is_high_latency": true,
    "language": "<string>",
    "media_key": "<string>",
    "scheduled_end_ms": "<string>",
    "scheduled_start_ms": "<string>",
    "share_url": "<string>",
    "source_id": "<string>",
    "start_ms": "<string>",
    "state": "<string>",
    "title": "<string>",
    "total_watched": "<string>",
    "total_watching": "<string>",
    "tweet_id": "<string>",
    "twitter_user_id": "<string>",
    "updated_at_ms": "<string>",
    "width": 123
  },
  "errors": [
    {
      "detail": "<string>",
      "resource_type": "<string>",
      "title": "<string>",
      "type": "https://api.x.com/2/problems/resource-not-found",
      "parameter": "<string>",
      "resource_id": "<string>",
      "status": 123,
      "value": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>"
}

Returns a broadcast owned by the authenticated user, looked up by its alphanumeric broadcast_id alone. This route replaces the deprecated Get Broadcast (GET /2/users/:user_id/broadcasts/:broadcast_id) — the owning user ID is no longer part of the path, and ownership is still enforced through the authenticated user context. Use broadcast.fields to select which Broadcast fields to return. Many fields (image URLs, start_ms, tweet_id, viewer counts) only populate after publish or later in the lifecycle.

The announcement post is created asynchronously after publish, so tweet_id is typically not present immediately — re-fetch the broadcast a moment later to read it.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string

required

Pattern: ^[a-zA-Z0-9]{1,13}$

Query Parameters

broadcast.fields

enum<string>[]

A comma separated list of Broadcast fields to display. The fields available for a Broadcast object.

Minimum array length: 1

Available options:

available_for_replay,

broadcast_id,

chat_option,

created_at_ms,

end_ms,

height,

id,

image_url,

image_url_medium,

image_url_small,

is_high_latency,

language,

media_key,

scheduled_end_ms,

scheduled_start_ms,

share_url,

source_id,

start_ms,

state,

title,

total_watched,

total_watching,

tweet_id,

twitter_user_id,

updated_at_ms,

width

Response

The request has succeeded.

data

object

Show child attributes

errors

object[]

Show child attributes

Get a broadcast

curl --request GET \
  --url https://api.x.com/2/broadcasts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.x.com/2/broadcasts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.x.com/2/broadcasts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.x.com/2/broadcasts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/broadcasts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "available_for_replay": true,
    "broadcast_id": "<string>",
    "chat_option": 123,
    "created_at_ms": "<string>",
    "end_ms": "<string>",
    "height": 123,
    "id": "<string>",
    "image_url": "<string>",
    "image_url_medium": "<string>",
    "image_url_small": "<string>",
    "is_high_latency": true,
    "language": "<string>",
    "media_key": "<string>",
    "scheduled_end_ms": "<string>",
    "scheduled_start_ms": "<string>",
    "share_url": "<string>",
    "source_id": "<string>",
    "start_ms": "<string>",
    "state": "<string>",
    "title": "<string>",
    "total_watched": "<string>",
    "total_watching": "<string>",
    "tweet_id": "<string>",
    "twitter_user_id": "<string>",
    "updated_at_ms": "<string>",
    "width": 123
  },
  "errors": [
    {
      "detail": "<string>",
      "resource_type": "<string>",
      "title": "<string>",
      "type": "https://api.x.com/2/problems/resource-not-found",
      "parameter": "<string>",
      "resource_id": "<string>",
      "status": 123,
      "value": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>"
}

Overview

Stream Sources

Broadcasts

Scheduled Broadcasts

Live Chat

Get Broadcast by ID

Authorizations

Path Parameters

Query Parameters

Response