> ## 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 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](/xdks/python/reference/xdk.stream.client)
* [`StreamClient`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient)
* [`StreamClient.__init__()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.__init__)
* [`StreamClient.get_rule_counts()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.get_rule_counts)
* [`StreamClient.get_rules()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.get_rules)
* [`StreamClient.labels_compliance()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.labels_compliance)
* [`StreamClient.likes_compliance()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.likes_compliance)
* [`StreamClient.likes_firehose()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.likes_firehose)
* [`StreamClient.likes_sample10()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.likes_sample10)
* [`StreamClient.posts()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts)
* [`StreamClient.posts_compliance()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_compliance)
* [`StreamClient.posts_firehose()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose)
* [`StreamClient.posts_firehose_en()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_en)
* [`StreamClient.posts_firehose_ja()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_ja)
* [`StreamClient.posts_firehose_ko()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_ko)
* [`StreamClient.posts_firehose_pt()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_firehose_pt)
* [`StreamClient.posts_sample()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_sample)
* [`StreamClient.posts_sample10()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.posts_sample10)
* [`StreamClient.update_rules()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.update_rules)
* [`StreamClient.users_compliance()`](/xdks/python/reference/xdk.stream.client#xdk.stream.client.StreamClient.users_compliance)
* [xdk.stream.models module](/xdks/python/reference/xdk.stream.models)
* [`GetRuleCountsResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRuleCountsResponse)
* [`GetRuleCountsResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRuleCountsResponse.model_config)
* [`GetRulesResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRulesResponse)
* [`GetRulesResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.GetRulesResponse.model_config)
* [`LabelsComplianceResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LabelsComplianceResponse)
* [`LabelsComplianceResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LabelsComplianceResponse.model_config)
* [`LikesComplianceResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesComplianceResponse)
* [`LikesComplianceResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesComplianceResponse.model_config)
* [`LikesFirehoseResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesFirehoseResponse)
* [`LikesFirehoseResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesFirehoseResponse.model_config)
* [`LikesSample10Response`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesSample10Response)
* [`LikesSample10Response.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.LikesSample10Response.model_config)
* [`PostsComplianceResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsComplianceResponse)
* [`PostsComplianceResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsComplianceResponse.model_config)
* [`PostsFirehoseEnResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseEnResponse)
* [`PostsFirehoseEnResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseEnResponse.model_config)
* [`PostsFirehoseJaResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseJaResponse)
* [`PostsFirehoseJaResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseJaResponse.model_config)
* [`PostsFirehoseKoResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseKoResponse)
* [`PostsFirehoseKoResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseKoResponse.model_config)
* [`PostsFirehosePtResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehosePtResponse)
* [`PostsFirehosePtResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehosePtResponse.model_config)
* [`PostsFirehoseResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseResponse)
* [`PostsFirehoseResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsFirehoseResponse.model_config)
* [`PostsResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsResponse)
* [`PostsResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsResponse.model_config)
* [`PostsSample10Response`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSample10Response)
* [`PostsSample10Response.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSample10Response.model_config)
* [`PostsSampleResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSampleResponse)
* [`PostsSampleResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.PostsSampleResponse.model_config)
* [`UpdateRulesRequest`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesRequest)
* [`UpdateRulesRequest.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesRequest.model_config)
* [`UpdateRulesResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesResponse)
* [`UpdateRulesResponse.model_config`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.UpdateRulesResponse.model_config)
* [`UsersComplianceResponse`](/xdks/python/reference/xdk.stream.models#xdk.stream.models.UsersComplianceResponse)
* [`UsersComplianceResponse.model_config`](/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
### `__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.