Submodules
- xdk.activity.client module
- xdk.activity.models module
Module contents
This module provides access to the activity endpoints of the X API and serves as the main entry point for all activity-related functionality.class xdk.activity.ActivityClient
Streaming Client for activity operations
Parameters
__init__
Parameters
create_subscription
Create X activity subscription
Creates a subscription for an X activity event
body: Request body
:returns: Response data
:rtype: CreateSubscriptionResponse
Parameters
delete_subscription
Deletes X activity subscription
Deletes a subscription for an X activity event
Parameters
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
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.
Request timeout in seconds (default: None for no timeout)
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
The ID of the subscription to update.
Request body