Get Broadcasts

GET

broadcasts

List broadcasts

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

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

fetch('https://api.x.com/2/broadcasts', 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",
  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"

	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")

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>"
    }
  ],
  "meta": {
    "next_token": "<string>",
    "result_count": 123
  }
}

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

Returns broadcasts owned by the authenticated user. This route replaces the deprecated List Broadcasts (GET /2/users/:user_id/broadcasts) — the owning user ID is no longer part of the path, and ownership is still enforced through the authenticated user context. The endpoint has two modes:

List — call it with no ids to page through the authenticated user’s broadcasts using pagination_token.
Bulk lookup — pass a comma-separated ids list (up to 100) to retrieve those specific broadcasts in a single request. Every returned broadcast must be owned by the authenticated user; IDs the caller does not own are omitted from data and reported in errors.

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.

Query Parameters

ids

string[]

Comma-separated broadcast IDs to retrieve instead of listing broadcasts.

Required array length: 1 - 100 elements

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

max_results

integer<int32>

Required range: 1 <= x <= 100

pagination_token

string

Minimum string length: 1

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

meta

object

Show child attributes

List broadcasts

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

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

fetch('https://api.x.com/2/broadcasts', 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",
  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"

	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")

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>"
    }
  ],
  "meta": {
    "next_token": "<string>",
    "result_count": 123
  }
}

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

Overview

Stream Sources

Broadcasts

Scheduled Broadcasts

Live Chat

Get Broadcasts

Authorizations

Query Parameters

Response