Rules lookup

GET

/2/tweets/search/stream/rules

Tweets

Returns rules from a user's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.twitter.com/2/tweets/search/stream/rules'

Response Example

200 - Example 1

{
  "data": [
    {
      "id": "120897978112909812",
      "tag": "Non-retweeted coffee tweets",
      "value": "coffee -is:retweet"
    }
  ],
  "meta": {
    "sent": "string",
    "summary": {
      "created": 1,
      "invalid": 1,
      "not_created": 1,
      "valid": 1
    }
  }
}

Request

Query Params

ids

array[string]

optional

A comma-separated list of Rule IDs.

Responses

🟢200The request was successful

application/json

Body

data

array[object (Rule) {3}]

required

string

optional

Unique identifier of this rule.

Example:

120897978112909812

Match pattern:

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

tag

string

optional

A tag meant for the labeling of user provided rules.

Example:

Non-retweeted coffee tweets

value

string

required

The filterlang value of the rule.

Example:

coffee -is:retweet