Subpaquetes
- xdk.account_activity package
- xdk.activity package
- xdk.communities package
- xdk.community_notes package
- xdk.compliance package
- xdk.connections package
- xdk.direct_messages package
- Submodules
- xdk.direct_messages.client module
- xdk.direct_messages.models module
CreateByConversationIdRequestCreateByConversationIdResponseCreateByParticipantIdRequestCreateByParticipantIdResponseCreateConversationRequestCreateConversationResponseDeleteEventsResponseGetEventsByConversationIdResponseGetEventsByIdResponseGetEventsByParticipantIdResponseGetEventsResponse
- Module contents
DirectMessagesClientDirectMessagesClient.__init__()DirectMessagesClient.create_by_conversation_id()DirectMessagesClient.create_by_participant_id()DirectMessagesClient.create_conversation()DirectMessagesClient.delete_events()DirectMessagesClient.get_events()DirectMessagesClient.get_events_by_conversation_id()DirectMessagesClient.get_events_by_id()DirectMessagesClient.get_events_by_participant_id()
- Submodules
- xdk.general package
- xdk.lists package
- xdk.media package
- Submodules
- xdk.media.client module
- xdk.media.models module
AppendUploadRequestAppendUploadResponseCreateMetadataRequestCreateMetadataResponseCreateSubtitlesRequestCreateSubtitlesResponseDeleteSubtitlesRequestDeleteSubtitlesResponseFinalizeUploadResponseGetAnalyticsResponseGetByKeyResponseGetByKeysResponseGetUploadStatusResponseInitializeUploadRequestInitializeUploadResponseUploadRequestUploadResponse
- Module contents
MediaClientMediaClient.__init__()MediaClient.append_upload()MediaClient.create_metadata()MediaClient.create_subtitles()MediaClient.delete_subtitles()MediaClient.finalize_upload()MediaClient.get_analytics()MediaClient.get_by_key()MediaClient.get_by_keys()MediaClient.get_upload_status()MediaClient.initialize_upload()MediaClient.upload()
- Submodules
- xdk.news package
- xdk.posts package
- Submodules
- xdk.posts.client module
- xdk.posts.models module
CreateRequestCreateResponseDeleteResponseGetAnalyticsResponseGetByIdResponseGetByIdsResponseGetCountsAllResponseGetCountsRecentResponseGetInsights28hrResponseGetInsightsHistoricalResponseGetLikingUsersResponseGetQuotedResponseGetRepostedByResponseGetRepostsResponseHideReplyRequestHideReplyResponseSearchAllResponseSearchRecentResponse
- Module contents
PostsClientPostsClient.__init__()PostsClient.create()PostsClient.delete()PostsClient.get_analytics()PostsClient.get_by_id()PostsClient.get_by_ids()PostsClient.get_counts_all()PostsClient.get_counts_recent()PostsClient.get_insights28hr()PostsClient.get_insights_historical()PostsClient.get_liking_users()PostsClient.get_quoted()PostsClient.get_reposted_by()PostsClient.get_reposts()PostsClient.hide_reply()PostsClient.search_all()PostsClient.search_recent()
- Submodules
- xdk.spaces package
- xdk.stream package
- Submodules
- xdk.stream.client module
- xdk.stream.models module
GetRuleCountsResponseGetRulesResponseLabelsComplianceResponseLikesComplianceResponseLikesFirehoseResponseLikesSample10ResponsePostsComplianceResponsePostsFirehoseEnResponsePostsFirehoseJaResponsePostsFirehoseKoResponsePostsFirehosePtResponsePostsFirehoseResponsePostsResponsePostsSample10ResponsePostsSampleResponseUpdateRulesRequestUpdateRulesResponseUsersComplianceResponse
- Module contents
StreamClientStreamClient.__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()
- Submodules
- xdk.trends package
- xdk.usage package
- xdk.users package
- Submodules
- xdk.users.client module
- xdk.users.models module
BlockDmsResponseCreateBookmarkRequestCreateBookmarkResponseDeleteBookmarkResponseFollowListRequestFollowListResponseFollowUserRequestFollowUserResponseGetBlockingResponseGetBookmarkFoldersResponseGetBookmarksByFolderIdResponseGetBookmarksResponseGetByIdResponseGetByIdsResponseGetByUsernameResponseGetByUsernamesResponseGetFollowedListsResponseGetFollowersResponseGetFollowingResponseGetLikedPostsResponseGetListMembershipsResponseGetMeResponseGetMentionsResponseGetMutingResponseGetOwnedListsResponseGetPinnedListsResponseGetPostsResponseGetRepostsOfMeResponseGetTimelineResponseLikePostRequestLikePostResponseMuteUserRequestMuteUserResponsePinListRequestPinListResponseRepostPostRequestRepostPostResponseSearchResponseUnblockDmsResponseUnfollowListResponseUnfollowUserResponseUnlikePostResponseUnmuteUserResponseUnpinListResponseUnrepostPostResponse
- Module contents
UsersClientUsersClient.__init__()UsersClient.block_dms()UsersClient.create_bookmark()UsersClient.delete_bookmark()UsersClient.follow_list()UsersClient.follow_user()UsersClient.get_blocking()UsersClient.get_bookmark_folders()UsersClient.get_bookmarks()UsersClient.get_bookmarks_by_folder_id()UsersClient.get_by_id()UsersClient.get_by_ids()UsersClient.get_by_username()UsersClient.get_by_usernames()UsersClient.get_followed_lists()UsersClient.get_followers()UsersClient.get_following()UsersClient.get_liked_posts()UsersClient.get_list_memberships()UsersClient.get_me()UsersClient.get_mentions()UsersClient.get_muting()UsersClient.get_owned_lists()UsersClient.get_pinned_lists()UsersClient.get_posts()UsersClient.get_reposts_of_me()UsersClient.get_timeline()UsersClient.like_post()UsersClient.mute_user()UsersClient.pin_list()UsersClient.repost_post()UsersClient.search()UsersClient.unblock_dms()UsersClient.unfollow_list()UsersClient.unfollow_user()UsersClient.unlike_post()UsersClient.unmute_user()UsersClient.unpin_list()UsersClient.unrepost_post()
- Submodules
- xdk.webhooks package
Submódulos
- xdk.client module
- xdk.oauth1_auth module
- xdk.oauth2_auth module
OAuth2PKCEAuthOAuth2PKCEAuth.__init__()OAuth2PKCEAuth.access_tokenOAuth2PKCEAuth.exchange_code()OAuth2PKCEAuth.fetch_token()OAuth2PKCEAuth.get_authorization_url()OAuth2PKCEAuth.get_code_challenge()OAuth2PKCEAuth.get_code_verifier()OAuth2PKCEAuth.is_token_expired()OAuth2PKCEAuth.refresh_token()OAuth2PKCEAuth.set_pkce_parameters()
- xdk.paginator module
- xdk.streaming module
StreamConfigStreamConfig.max_retriesStreamConfig.initial_backoffStreamConfig.max_backoffStreamConfig.backoff_multiplierStreamConfig.jitterStreamConfig.timeoutStreamConfig.chunk_sizeStreamConfig.on_connectStreamConfig.on_disconnectStreamConfig.on_reconnectStreamConfig.on_errorStreamConfig.__init__()StreamConfig.backoff_multiplierStreamConfig.chunk_sizeStreamConfig.initial_backoffStreamConfig.jitterStreamConfig.max_backoffStreamConfig.max_retriesStreamConfig.on_connectStreamConfig.on_disconnectStreamConfig.on_errorStreamConfig.on_reconnectStreamConfig.timeout
StreamErrorStreamErrorTypeStreamStatestream_with_retry()
Contenido del módulo
SDK de Python XDK. Un SDK de Python para la X API que ofrece acceso conveniente a los endpoints de la X API con seguridad de tipos y soporte de autenticación.class xdk.Client
Cliente para interactuar con la X API.
Parámetros
str
default:"'https://api.x.com'"
str or None
default:"None"
str or None
default:"None"
str or None
default:"None"
str or None
default:"None"
str or None
default:"None"
Dict[str, Any] or None
default:"None"
str or List[str] or None
default:"None"
str
default:"'https://x.com/i'"
OAuth1
__init__
Inicializa el cliente de la X API.
Parámetros
str
default:"'https://api.x.com'"
La URL base de la X API (por defecto https://api.x.com).
str or None
default:"None"
El bearer token para la X API (autenticación app-only).
str or None
default:"None"
El access token de OAuth2 para contexto de usuario (puede usarse directamente como bearer token).
str or None
default:"None"
El client ID para la X API (requerido para el flujo OAuth2 PKCE).
str or None
default:"None"
El client secret para la X API.
str or None
default:"None"
La URI de redirección para la autorización OAuth2.
Dict[str, Any] or None
default:"None"
Un diccionario de token OAuth2 existente (si está disponible). Si se proporciona, se extraerá access_token.
str or List[str] or None
default:"None"
Cadena separada por espacios o lista de cadenas para los scopes de autorización OAuth2.
str
default:"'https://x.com/i'"
La URL base para la autorización OAuth2 (por defecto https://x.com/i).
OAuth1
Instancia de OAuth1 para la autenticación OAuth 1.0a.
exchange_code
Intercambia el código de autorización por tokens (coincide con la API de TypeScript).
Parámetros
Any
El código de autorización del callback.
Any
default:"None"
Verificador de código opcional (usa el verificador almacenado si no se proporciona).
fetch_token
Obtiene el token usando la URL de respuesta de autorización (método heredado).
Parámetros
Any
La URL de callback completa recibida después de la autorización.
get_authorization_url
Obtiene la URL de autorización para el flujo OAuth2 PKCE.
Parámetros
Any
default:"None"
Parámetro de estado opcional por seguridad.
is_token_expired
Verifica si el token OAuth2 ha expirado.
refresh_token
Renueva el token OAuth2.
class xdk.Cursor
[ResponseType]
Parámetros
PaginatableMethod
__init__
Inicializa el cursor.
Parámetros
PaginatableMethod
El método de la API a llamar por cada página (debe admitir paginación)
items
Itera sobre elementos individuales de respuestas paginadas.
Parámetros
int or None
default:"None"
Número máximo de elementos a devolver (None para ilimitado)
Devuelve
IteratorAny
pages
Itera sobre páginas de respuestas.
Parámetros
int or None
default:"None"
Número máximo de páginas a devolver (None para ilimitado)
Devuelve
IteratorResponseType
class xdk.StreamConfig
Configuración para conexiones de streaming con comportamiento de reintentos.
Parámetros
int
default:"10"
float
default:"1.0"
float
default:"64.0"
float
default:"2.0"
bool
default:"True"
float or None
default:"None"
int
default:"1024"
Callable[[], None] or None
default:"None"
Callable[[Exception or None], None] or None
default:"None"
Callable[[int, float], None] or None
default:"None"
Callable[[[StreamError
__init__
Parámetros
int
default:"10"
float
default:"1.0"
float
default:"64.0"
float
default:"2.0"
bool
default:"True"
float or None
default:"None"
int
default:"1024"
Callable[[], None] or None
default:"None"
Callable[[Exception or None], None] or None
default:"None"
Callable[[int, float], None] or None
default:"None"
Callable[[[StreamError
on_error : Callable[[[StreamError]
exception xdk.StreamError
Excepción lanzada para errores de streaming con clasificación.
Parámetros
str
StreamErrorType
__init__
Parámetros
str
StreamErrorType
class xdk.StreamErrorType
Clasificación de errores de streaming para decisiones de reintento.
Parámetros
Any
class xdk.StreamState
Estado interno de una conexión de streaming.
Parámetros
int
default:"0"
float
default:"1.0"
bool
default:"False"
int
default:"0"
StreamError
__init__
Parámetros
int
default:"0"
float
default:"1.0"
bool
default:"False"
int
default:"0"
StreamError
last_error : [StreamError]
xdk.cursor
Crea un cursor con inferencia y validación de tipos adecuadas.
Esta función factory ayuda con la inferencia de tipos para que obtengas
sugerencias de tipo adecuadas para el tipo de respuesta, y valida que el método
admita paginación tanto en análisis estático como en tiempo de ejecución.
Parámetros
PaginatableMethod
El método de la API a envolver (debe admitir paginación)