Skip to main content
This module provides a client for interacting with the activity endpoints of the X API. Real-time streaming operations return generators that yield data as it arrives.

​
ActivityClient

Class Bases: object Streaming Client for activity operations

​
Constructors

​
__init__

​
Parameters

​
path.client
Client

​
create_subscription

Create X activity subscription Creates a subscription for an X activity event body: Request body :returns: Response data :rtype: CreateSubscriptionResponse

​
Parameters

​
body.body
CreateSubscriptionRequest

​
delete_subscription

Deletes X activity subscription Deletes a subscription for an X activity event

​
Parameters

​
path.subscription_id
Any
The ID of the subscription to delete.

​
Returns

DeleteSubscriptionResponse - Response data

​
get_subscriptions

Get X activity subscriptions Get a list of active subscriptions for XAA :returns: Response data :rtype: GetSubscriptionsResponse

​
Returns

GetSubscriptionsResponse

​
stream

Activity Stream (Streaming) Stream of X Activities 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.

​
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.timeout
float or None
default:"None"
Request timeout in seconds (default: None for no timeout)
​
path.chunk_size
int
default:"1024"
Size of chunks to read from the stream (default: 1024 bytes)

​
Returns

GeneratorStreamResponse, None, None

​
update_subscription

Update X activity subscription Updates a subscription for an X activity event

​
Parameters

​
path.subscription_id
Any
The ID of the subscription to update.
​
body.body
UpdateSubscriptionRequest
Request body