Get stream rules

Retrieves the active rule set or a subset of rules for the filtered stream.

GET /2/tweets/search/stream/rules

Get stream rules

cURL

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

import requests

url = "https://api.x.com/2/tweets/search/stream/rules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

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

}

HttpResponse<String> response = Unirest.get("https://api.x.com/2/tweets/search/stream/rules")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/tweets/search/stream/rules")

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

200

{
  "meta": {
    "sent": "<string>",
    "next_token": "<string>",
    "result_count": 123,
    "summary": {
      "created": 1,
      "invalid": 1,
      "not_created": 1,
      "valid": 1
    }
  },
  "data": [
    {
      "value": "coffee -is:retweet",
      "id": "120897978112909812",
      "tag": "Non-retweeted coffee Posts"
    }
  ]
}

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ids · string[]

A comma-separated list of Rule IDs.

Unique identifier of this rule.

Pattern: ^[0-9]{1,19}$

max_results · integer<int32> · default: 1000

The maximum number of results.

Required range: 1 <= x <= 1000

pagination_token · string

This value is populated by passing the 'next_token' returned in a request to paginate through results.

Required string length: 16

Response

200

application/json

The request has succeeded.

meta · object · required

Show child attributes

data · object[]

Show child attributes