> ## 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. # StreamClient > Reference for the stream Python package in the X API SDK, grouping the client and Pydantic models for the stream endpoints of the X API v2. ## Submodules * [xdk.stream.client module](https://docs.x.com/xdks/python/reference/xdk.stream.client.md) * [`StreamClient`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient) * [`StreamClient.__init__()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.__init__) * [`StreamClient.get_rule_counts()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.get_rule_counts) * [`StreamClient.get_rules()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.get_rules) * [`StreamClient.labels_compliance()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.labels_compliance) * [`StreamClient.likes_compliance()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.likes_compliance) * [`StreamClient.likes_firehose()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.likes_firehose) * [`StreamClient.likes_sample10()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.likes_sample10) * [`StreamClient.posts()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts) * [`StreamClient.posts_compliance()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_compliance) * [`StreamClient.posts_firehose()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose) * [`StreamClient.posts_firehose_en()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_en) * [`StreamClient.posts_firehose_ja()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_ja) * [`StreamClient.posts_firehose_ko()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_ko) * [`StreamClient.posts_firehose_pt()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_pt) * [`StreamClient.posts_sample()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_sample) * [`StreamClient.posts_sample10()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_sample10) * [`StreamClient.update_rules()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.update_rules) * [`StreamClient.users_compliance()`](https://docs.x.com/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.users_compliance) * [xdk.stream.models module](https://docs.x.com/xdks/python/reference/xdk.stream.models.md) * [`GetRuleCountsResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRuleCountsResponse) * [`GetRuleCountsResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRuleCountsResponse.model_config) * [`GetRulesResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRulesResponse) * [`GetRulesResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRulesResponse.model_config) * [`LabelsComplianceResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LabelsComplianceResponse) * [`LabelsComplianceResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LabelsComplianceResponse.model_config) * [`LikesComplianceResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesComplianceResponse) * [`LikesComplianceResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesComplianceResponse.model_config) * [`LikesFirehoseResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesFirehoseResponse) * [`LikesFirehoseResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesFirehoseResponse.model_config) * [`LikesSample10Response`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesSample10Response) * [`LikesSample10Response.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesSample10Response.model_config) * [`PostsComplianceResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsComplianceResponse) * [`PostsComplianceResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsComplianceResponse.model_config) * [`PostsFirehoseEnResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseEnResponse) * [`PostsFirehoseEnResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseEnResponse.model_config) * [`PostsFirehoseJaResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseJaResponse) * [`PostsFirehoseJaResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseJaResponse.model_config) * [`PostsFirehoseKoResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseKoResponse) * [`PostsFirehoseKoResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseKoResponse.model_config) * [`PostsFirehosePtResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehosePtResponse) * [`PostsFirehosePtResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehosePtResponse.model_config) * [`PostsFirehoseResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseResponse) * [`PostsFirehoseResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseResponse.model_config) * [`PostsResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsResponse) * [`PostsResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsResponse.model_config) * [`PostsSample10Response`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSample10Response) * [`PostsSample10Response.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSample10Response.model_config) * [`PostsSampleResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSampleResponse) * [`PostsSampleResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSampleResponse.model_config) * [`UpdateRulesRequest`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesRequest) * [`UpdateRulesRequest.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesRequest.model_config) * [`UpdateRulesResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesResponse) * [`UpdateRulesResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesResponse.model_config) * [`UsersComplianceResponse`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.UsersComplianceResponse) * [`UsersComplianceResponse.model_config`](https://docs.x.com/xdks/python/reference/xdk.stream.models#xdk.stream.models.UsersComplianceResponse.model_config) ## Module contents This module provides access to the stream endpoints of the X API and serves as the main entry point for all stream-related functionality. ### `class xdk.stream.StreamClient` Streaming Client for stream operations #### Parameters **path.client** `Client` ### `__init__` #### Parameters **path.client** `Client` ### `get_rule_counts` Get stream rule counts Retrieves the count of rules in the active rule set for the filtered stream. #### Parameters **path.rules\_count\_fields** `List or None` (default: None) A comma separated list of RulesCount fields to display. #### Returns `GetRuleCountsResponse` - Response data ### `get_rules` Get stream rules Retrieves the active rule set or a subset of rules for the filtered stream. #### Parameters **path.ids** `List or None` (default: None) A comma-separated list of Rule IDs. **path.max\_results** `int or None` (default: None) The maximum number of results. **path.pagination\_token** `str or None` (default: None) This value is populated by passing the ‘next\_token’ returned in a request to paginate through results. #### Returns `IteratorGetRulesResponse` ### `labels_compliance` Stream Post labels (Streaming) Streams all labeling events applied to Posts. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `likes_compliance` Stream Likes compliance data (Streaming) Streams all compliance data related to Likes for Users. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `likes_firehose` Stream all Likes (Streaming) Streams all public Likes in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.like\_with\_tweet\_author\_fields** `List or None` (default: None) A comma separated list of LikeWithTweetAuthor fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `likes_sample10` Stream sampled Likes (Streaming) Streams a 10% sample of public Likes in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.like\_with\_tweet\_author\_fields** `List or None` (default: None) A comma separated list of LikeWithTweetAuthor fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts` Stream filtered Posts (Streaming) Streams Posts in real-time matching the active rule set. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_compliance` Stream Posts compliance data (Streaming) Streams all compliance data related to Posts. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Post Compliance events will be provided. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_firehose` Stream all Posts (Streaming) Streams all public Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_firehose_en` Stream English Posts (Streaming) Streams all public English-language Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_firehose_ja` Stream Japanese Posts (Streaming) Streams all public Japanese-language Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_firehose_ko` Stream Korean Posts (Streaming) Streams all public Korean-language Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_firehose_pt` Stream Portuguese Posts (Streaming) Streams all public Portuguese-language Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_sample` Stream sampled Posts (Streaming) Streams a 1% sample of public Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `posts_sample10` Stream 10% sampled Posts (Streaming) Streams a 10% sample of public Posts in real-time. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. **path.tweet\_fields** `List or None` (default: None) A comma separated list of Tweet fields to display. **path.expansions** `List or None` (default: None) A comma separated list of fields to expand. **path.media\_fields** `List or None` (default: None) A comma separated list of Media fields to display. **path.poll\_fields** `List or None` (default: None) A comma separated list of Poll fields to display. **path.user\_fields** `List or None` (default: None) A comma separated list of User fields to display. **path.place\_fields** `List or None` (default: None) A comma separated list of Place fields to display. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks. ### `update_rules` Update stream rules Adds or deletes rules from the active rule set for the filtered stream. #### Parameters **body.body** `UpdateRulesRequest` Request body ### `users_compliance` Stream Users compliance data (Streaming) Streams all compliance data related to Users. This is a streaming endpoint that yields data in real-time as it becomes available. Each yielded item represents a single data point from the stream. The connection is automatically managed with exponential backoff retry logic. If the stream disconnects, the SDK will automatically reconnect without client intervention. #### Parameters **path.partition** `int` The partition number. **path.backfill\_minutes** `int or None` (default: None) The number of minutes of backfill requested. **path.start\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided. **path.end\_time** `str or None` (default: None) YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided. **path.stream\_config** `StreamConfig` Optional StreamConfig for customizing retry behavior, timeouts, and callbacks.