Skip to main content

하위 모듈

모듈 내용

이 모듈은 X API의 stream 엔드포인트에 대한 액세스를 제공합니다. 모든 stream-related 기능의 주요 진입점 역할을 합니다.

class xdk.stream.StreamClient

Streaming Client for stream operations

매개변수

Client

__init__

매개변수

Client

get_rule_counts

Get stream rule counts Retrieves the count of rules in the active rule set for the filtered stream.

매개변수

List or None
default:"None"
A comma separated list of RulesCount fields to display.

반환값

GetRuleCountsResponse - 응답 데이터

get_rules

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

매개변수

List or None
default:"None"
A comma-separated list of Rule IDs.
int or None
default:"None"
결과의 최대 개수입니다.
str or None
default:"None"
This value is populated by passing the ‘next_token’ returned in a request to paginate through results.

반환값

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.

매개변수

int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided.
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.

매개변수

int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
A comma separated list of LikeWithTweetAuthor fields to display.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
A comma separated list of LikeWithTweetAuthor fields to display.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Post Compliance events will be provided.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int or None
default:"None"
The number of minutes of backfill requested.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.
List or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
List or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.
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.

매개변수

UpdateRulesRequest
요청 본문

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.

매개변수

int
The partition number.
int or None
default:"None"
The number of minutes of backfill requested.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided.
str or None
default:"None"
YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided.
StreamConfig
Optional StreamConfig for customizing retry behavior, timeouts, and callbacks.