Filtered stream v1

GET /labs/1/tweets/stream/filter/rules

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Run in Postman ❯ 


Endpoint URL

https://api.twitter.com/labs/1/tweets/stream/filter/rules

Authentication and rate limits

Authentication methods
supported by this endpoint

OAuth 2.0 Bearer token

Rate limit450 requests per 15-minute window

Learn more about rate limits.



Query parameters

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


Examples

  • cURL
curl -X GET -H "Authorization: Bearer $BEARER_TOKEN" "https://api.twitter.com/labs/1/tweets/stream/filter/rules?ids=1165037377523306498,1165037377523306497"

Response

  • Response
{
  "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 filter.
tagstringThe tag label as defined when creating the filter.
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.