StreamClient

​

Submodules

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

​

Returns

GetRuleCountsResponse - Response data

​

get_rules

Get stream rules Retrieves the active rule set or a subset of rules for the filtered stream.

​

Parameters

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

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

​

update_rules

Update stream rules Adds or deletes rules from the active rule set for the filtered stream.

​

Parameters

​

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