> ## Documentation Index > Fetch the complete documentation index at: https://x-preview-mintlify-066e8699.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # StreamClient > Reference for the stream.client Python module in the X API SDK. Client class and methods for calling the stream endpoints of the X API v2. This module provides a client for interacting with the stream endpoints of the X API. Real-time streaming operations return generators that yield data as it arrives. Streaming connections are automatically managed with exponential backoff retry logic for robust handling. ## StreamClient Class Bases: object Streaming Client for stream operations ## Constructors ### `__init__` #### Parameters ### `get_rule_counts` Get stream rule counts Retrieves the count of rules in the active rule set for the filtered stream. #### Parameters 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 A comma-separated list of Rule IDs. The maximum number of results. 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 The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided. 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 The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of LikeWithTweetAuthor fields to display. A comma separated list of fields to expand. A comma separated list of User fields to display. A comma separated list of Tweet fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of LikeWithTweetAuthor fields to display. A comma separated list of fields to expand. A comma separated list of User fields to display. A comma separated list of Tweet fields to display. 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 The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Post Compliance events will be provided. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The number of minutes of backfill requested. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided. A comma separated list of Tweet fields to display. A comma separated list of fields to expand. A comma separated list of Media fields to display. A comma separated list of Poll fields to display. A comma separated list of User fields to display. A comma separated list of Place fields to display. 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 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 The partition number. The number of minutes of backfill requested. YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided. YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided. Optional StreamConfig for customizing retry behavior, timeouts, and callbacks.