|
1 | | ---- |
2 | | -title: Introduction |
3 | | -sidebarTitle: Introduction |
4 | | ---- |
5 | | - |
6 | | -import { Button } from '/snippets/button.mdx'; |
7 | | - |
8 | | -The filtered stream endpoint group enables developers to filter the real-time stream of public Posts. This endpoint group’s functionality includes multiple endpoints that enable you to create and manage rules, and apply those rules to filter a stream of real-time Posts that will return matching public Posts. This endpoint group allows users to listen for specific topics and events in real-time, monitor the conversation around competitions, understand how trends develop in real-time, and much more. |
9 | | - |
10 | | -Developers can use the REST [rules endpoint](/x-api/posts/filtered-stream#post-2-tweets-search-stream-rules) to add and remove rules to a persistent stream connection without needing to disconnect. These [rules](/x-api/posts/filtered-stream#building-rules-for-filtered-stream) can be created with operators that match on Post attributes such as message keywords, hashtags, and URLs. Operators and rule clauses can be combined with boolean logic and parentheses to help refine the filter’s matching behavior. |
11 | | - |
12 | | -Once you've added a set of rules, you can [establish a streaming connection](/x-api/posts/filtered-stream#get-2-tweets-search-stream) which will start to deliver [Post objects](/x-api/fundamentals/data-dictionary#tweet) in JSON format through a persistent HTTP Streaming connection. You will only receive content matching your rules while connected to the stream. |
13 | | - |
14 | | -The filtered search endpoint supports edited Posts. This endpoint will deliver edited Posts that match one or more of your filters, along with its edit history, including an array of Post IDs. For Posts with no edit history, this array will hold a single ID. For Posts that have been edited, this array contains multiple IDs, arranged in ascending order reflecting the order of edits, with the most recent version in the last position of the array. To learn more about how Post edits work, see the [Posts edits fundamentals](/x-api/fundamentals/edit-posts) page. |
15 | | - |
16 | | -Certain aspects of the filtered stream endpoint are limited by [access level](/x-api/getting-started/about-x-api): |
17 | | - |
18 | | -**Pro access** |
19 | | - |
20 | | -* 1000 rules per stream |
21 | | -* 100 requests per 15 minutes when using the POST /2/tweets/search/stream/rules endpoint to add rules |
22 | | -* Can use all operators when building your rule |
23 | | -* Can build rules up to 1024 characters in length |
24 | | - |
25 | | - |
26 | | -**Enterprise access** |
27 | | - |
28 | | -* 25,000+ rules per stream |
29 | | -* Can use all operators when building your rule |
30 | | -* Can build rules up to 2048 characters in length |
31 | | -* Apply [here](https://developer.x.com/en/products/x-api/enterprise/enterprise-api-interest-form) for Enterprise access |
32 | | - |
33 | | -The returned Posts from filtered stream count towards the monthly [Post cap](/x-api/fundamentals/post-cap). |
34 | | - |
35 | | -<Note> |
36 | | -**Account setup** |
37 | | - |
38 | | -To access these endpoints, you will need: |
39 | | - |
40 | | -* An approved [developer account](https://developer.x.com/en/portal/petition/essential/basic-info). |
41 | | -* To authenticate using the keys and tokens from a [developer App](/resources/fundamentals/developer-apps) that is located within a [Project](/resources/fundamentals/projects). |
42 | | - |
43 | | -Learn more about getting access to the X API v2 endpoints in our [getting started guide](/x-api/getting-started/getting-access). |
44 | | -</Note> |
45 | | - |
46 | | - |
47 | | - |
48 | | -<div className="flex"> |
49 | | -<Button href="/x-api/posts/filtered-stream/quickstart"> |
50 | | - Quick start |
51 | | -</Button> |
52 | | -<Button href="https://github.com/xdevplatform/Twitter-API-v2-sample-code"> |
53 | | - Sample code |
54 | | -</Button> |
55 | | -<Button href="https://www.postman.com/xapidevelopers/"> |
56 | | - Run in Postman |
57 | | -</Button> |
58 | | -<Button href="https://developer.x.com/apitools/api?endpoint=/2/tweets&method=post"> |
59 | | - Try with API Explorer |
60 | | -</Button> |
61 | | -</div> |
| 1 | +--- |
| 2 | +title: Introduction |
| 3 | +sidebarTitle: Introduction |
| 4 | +--- |
| 5 | + |
| 6 | +import { Button } from '/snippets/button.mdx'; |
| 7 | + |
| 8 | +The filtered stream endpoint group enables developers to filter the real-time stream of public Posts. This endpoint group’s functionality includes multiple endpoints that enable you to create and manage rules, and apply those rules to filter a stream of real-time Posts that will return matching public Posts. This endpoint group allows users to listen for specific topics and events in real-time, monitor the conversation around competitions, understand how trends develop in real-time, and much more. |
| 9 | + |
| 10 | +Developers can use the REST [rules endpoint](/x-api/posts/filtered-stream#post-2-tweets-search-stream-rules) to add and remove rules to a persistent stream connection without needing to disconnect. These [rules](/x-api/posts/filtered-stream#building-rules-for-filtered-stream) can be created with operators that match on Post attributes such as message keywords, hashtags, and URLs. Operators and rule clauses can be combined with boolean logic and parentheses to help refine the filter’s matching behavior. |
| 11 | + |
| 12 | +Once you've added a set of rules, you can [establish a streaming connection](/x-api/posts/filtered-stream#get-2-tweets-search-stream) which will start to deliver [Post objects](/x-api/fundamentals/data-dictionary#tweet) in JSON format through a persistent HTTP Streaming connection. You will only receive content matching your rules while connected to the stream. |
| 13 | + |
| 14 | +The filtered search endpoint supports edited Posts. This endpoint will deliver edited Posts that match one or more of your filters, along with its edit history, including an array of Post IDs. For Posts with no edit history, this array will hold a single ID. For Posts that have been edited, this array contains multiple IDs, arranged in ascending order reflecting the order of edits, with the most recent version in the last position of the array. To learn more about how Post edits work, see the [Posts edits fundamentals](/x-api/fundamentals/edit-posts) page. |
| 15 | + |
| 16 | +Certain aspects of the filtered stream endpoint are limited by [access level](/x-api/getting-started/about-x-api): |
| 17 | + |
| 18 | +**Pro access** |
| 19 | + |
| 20 | +* 1000 rules per project |
| 21 | +* 100 requests per 15 minutes when using the POST /2/tweets/search/stream/rules endpoint to add rules |
| 22 | +* Can use all operators when building your rule |
| 23 | +* Can build rules up to 1024 characters in length |
| 24 | + |
| 25 | + |
| 26 | +**Enterprise access** |
| 27 | + |
| 28 | +* 25,000+ rules per project |
| 29 | +* Can use all operators when building your rule |
| 30 | +* Can build rules up to 2048 characters in length |
| 31 | +* Apply [here](https://developer.x.com/en/products/x-api/enterprise/enterprise-api-interest-form) for Enterprise access |
| 32 | + |
| 33 | +The returned Posts from filtered stream count towards the monthly [Post cap](/x-api/fundamentals/post-cap). |
| 34 | + |
| 35 | +<Note> |
| 36 | +**Account setup** |
| 37 | + |
| 38 | +To access these endpoints, you will need: |
| 39 | + |
| 40 | +* An approved [developer account](https://developer.x.com/en/portal/petition/essential/basic-info). |
| 41 | +* To authenticate using the keys and tokens from a [developer App](/resources/fundamentals/developer-apps) that is located within a [Project](/resources/fundamentals/projects). |
| 42 | + |
| 43 | +Learn more about getting access to the X API v2 endpoints in our [getting started guide](/x-api/getting-started/getting-access). |
| 44 | +</Note> |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | +<div className="flex"> |
| 49 | +<Button href="/x-api/posts/filtered-stream/quickstart"> |
| 50 | + Quick start |
| 51 | +</Button> |
| 52 | +<Button href="https://github.com/xdevplatform/Twitter-API-v2-sample-code"> |
| 53 | + Sample code |
| 54 | +</Button> |
| 55 | +<Button href="https://www.postman.com/xapidevelopers/"> |
| 56 | + Run in Postman |
| 57 | +</Button> |
| 58 | +<Button href="https://developer.x.com/apitools/api?endpoint=/2/tweets&method=post"> |
| 59 | + Try with API Explorer |
| 60 | +</Button> |
| 61 | +</div> |
0 commit comments