Skip to main content
GET
/
2
/
tweets
/
search
/
stream
/
rules
Get stream rules
curl --request GET \
  --url https://api.x.com/2/tweets/search/stream/rules \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

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

The request has succeeded.

​
meta
object
required
​
data
object[]