GET /2/tweets/search/stream/rules

Return either a single rule, or a list of rules that have been added to the stream.

If you would like to initiate the stream to receive all Tweets that match these rules in real-time, you will need to use the GET /tweets/search/stream endpoint.

Endpoint URL

https://api.twitter.com/2/tweets/search/stream/rules

Authentication and rate limits

Authentication methods
supported by this endpoint

OAuth 2.0 App-only

Rate limit

App rate limit (OAuth 2.0 App Access Token): 450 requests per 15-minute window shared among all users of your app

Query parameters

NameTypeDescription
ids
 Optional 
stringComma-separated list of rule IDs. If omitted, all rules are returned.


Example requests

      curl -v https://api.twitter.com/2/tweets/search/stream/rules -H "Authorization: Bearer $ACCESS_TOKEN"
    

Example responses

      {
  "data": [
    {
      "id": "1165037377523306497",
      "value": "dog has:images",
      "tag": "dog pictures"
    },
    {
      "id": "1165037377523306498",
      "value": "cat has:images -grumpy"
    }
  ],
  "meta": {
    "sent": "2019-08-29T01:12:10.729Z"
  }
}
    

Response fields

NameTypeDescription
idstringUnique identifier of this rule. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
valuestringThe rule text as submitted when creating the rule.
tagstringThe tag label as defined when creating the rule.
meta.sentnumberThe time when the request body was returned.
errorsobjectContains details about errors that affected any of the requested Tweets. See Status codes and error messages for more details.