Client

​

Subpaquetes

• Paquete xdk.account_activity
  • Submódulos
    • módulo xdk.account_activity.client
      • AccountActivityClient
    • módulo xdk.account_activity.models
      • CreateReplayJobResponse
      • CreateSubscriptionRequest
      • CreateSubscriptionResponse
      • DeleteSubscriptionResponse
      • GetSubscriptionCountResponse
      • GetSubscriptionsResponse
      • ValidateSubscriptionResponse
  • Contenido del módulo
    • AccountActivityClient
      • AccountActivityClient.__init__()
      • AccountActivityClient.create_replay_job()
      • AccountActivityClient.create_subscription()
      • AccountActivityClient.delete_subscription()
      • AccountActivityClient.get_subscription_count()
      • AccountActivityClient.get_subscriptions()
      • AccountActivityClient.validate_subscription()
• Paquete xdk.activity
  • Submódulos
    • módulo xdk.activity.client
      • ActivityClient
    • módulo xdk.activity.models
      • CreateSubscriptionRequest
      • CreateSubscriptionResponse
      • DeleteSubscriptionResponse
      • GetSubscriptionsResponse
      • StreamResponse
      • UpdateSubscriptionRequest
      • UpdateSubscriptionResponse
  • Contenido del módulo
    • ActivityClient
      • ActivityClient.__init__()
      • ActivityClient.create_subscription()
      • ActivityClient.delete_subscription()
      • ActivityClient.get_subscriptions()
      • ActivityClient.stream()
      • ActivityClient.update_subscription()
• paquete xdk.communities
  • Submódulos
    • módulo xdk.communities.client
      • CommunitiesClient
    • módulo xdk.communities.models
      • GetByIdResponse
      • SearchResponse
  • Contenido del módulo
    • CommunitiesClient
      • CommunitiesClient.__init__()
      • CommunitiesClient.get_by_id()
      • CommunitiesClient.search()
• paquete xdk.community_notes
  • Submódulos
    • módulo xdk.community_notes.client
      • CommunityNotesClient
    • módulo xdk.community_notes.models
      • CreateRequest
      • CreateResponse
      • DeleteResponse
      • EvaluateRequest
      • EvaluateResponse
      • SearchEligiblePostsResponse
      • SearchWrittenResponse
  • Contenido del módulo
    • CommunityNotesClient
      • CommunityNotesClient.__init__()
      • CommunityNotesClient.create()
      • CommunityNotesClient.delete()
      • CommunityNotesClient.evaluate()
      • CommunityNotesClient.search_eligible_posts()
      • CommunityNotesClient.search_written()
• Paquete xdk.compliance
  • Submódulos
    • módulo xdk.compliance.client
      • ComplianceClient
    • módulo xdk.compliance.models
      • CreateJobsRequest
      • CreateJobsResponse
      • GetJobsByIdResponse
      • GetJobsResponse
  • Contenido del módulo
    • ComplianceClient
      • ComplianceClient.__init__()
      • ComplianceClient.create_jobs()
      • ComplianceClient.get_jobs()
      • ComplianceClient.get_jobs_by_id()
• Paquete xdk.connections
  • Submódulos
    • módulo xdk.connections.client
      • ConnectionsClient
    • módulo xdk.connections.models
      • DeleteAllResponse
  • Contenido del módulo
    • ConnectionsClient
      • ConnectionsClient.__init__()
      • ConnectionsClient.delete_all()
• paquete xdk.direct_messages
  • Submódulos
    • módulo xdk.direct_messages.client
      • DirectMessagesClient
    • módulo xdk.direct_messages.models
      • CreateByConversationIdRequest
      • CreateByConversationIdResponse
      • CreateByParticipantIdRequest
      • CreateByParticipantIdResponse
      • CreateConversationRequest
      • CreateConversationResponse
      • DeleteEventsResponse
      • GetEventsByConversationIdResponse
      • GetEventsByIdResponse
      • GetEventsByParticipantIdResponse
      • GetEventsResponse
  • Contenido del módulo
    • DirectMessagesClient
      • DirectMessagesClient.__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()
• Paquete xdk.general
  • Submódulos
    • módulo xdk.general.client
      • GeneralClient
    • módulo xdk.general.models
      • GetOpenApiSpecResponse
  • Contenido del módulo
    • GeneralClient
      • GeneralClient.__init__()
      • GeneralClient.get_open_api_spec()
• Paquete xdk.lists
  • Submódulos
    • módulo xdk.lists.client
      • ListsClient
    • módulo xdk.lists.models
      • AddMemberRequest
      • AddMemberResponse
      • CreateRequest
      • CreateResponse
      • DeleteResponse
      • GetByIdResponse
      • GetFollowersResponse
      • GetMembersResponse
      • GetPostsResponse
      • RemoveMemberByUserIdResponse
      • UpdateRequest
      • UpdateResponse
  • Contenido del módulo
    • ListsClient
      • ListsClient.__init__()
      • ListsClient.add_member()
      • ListsClient.create()
      • ListsClient.delete()
      • ListsClient.get_by_id()
      • ListsClient.get_followers()
      • ListsClient.get_members()
      • ListsClient.get_posts()
      • ListsClient.remove_member_by_user_id()
      • ListsClient.update()
• Paquete xdk.media
  • Submódulos
    • módulo xdk.media.client
      • MediaClient
    • módulo xdk.media.models
      • AppendUploadRequest
      • AppendUploadResponse
      • CreateMetadataRequest
      • CreateMetadataResponse
      • CreateSubtitlesRequest
      • CreateSubtitlesResponse
      • DeleteSubtitlesRequest
      • DeleteSubtitlesResponse
      • FinalizeUploadResponse
      • GetAnalyticsResponse
      • GetByKeyResponse
      • GetByKeysResponse
      • GetUploadStatusResponse
      • InitializeUploadRequest
      • InitializeUploadResponse
      • UploadRequest
      • UploadResponse
  • Contenido del módulo
    • MediaClient
      • MediaClient.__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()
• Paquete xdk.news
  • Submódulos
    • módulo xdk.news.client
      • NewsClient
    • módulo xdk.news.models
      • GetResponse
      • SearchResponse
  • Contenido del módulo
    • NewsClient
      • NewsClient.__init__()
      • NewsClient.get()
      • NewsClient.search()
• Paquete xdk.posts
  • Submódulos
    • módulo xdk.posts.client
      • PostsClient
    • módulo xdk.posts.models
      • CreateRequest
      • CreateResponse
      • DeleteResponse
      • GetAnalyticsResponse
      • GetByIdResponse
      • GetByIdsResponse
      • GetCountsAllResponse
      • GetCountsRecentResponse
      • GetInsights28hrResponse
      • GetInsightsHistoricalResponse
      • GetLikingUsersResponse
      • GetQuotedResponse
      • GetRepostedByResponse
      • GetRepostsResponse
      • HideReplyRequest
      • HideReplyResponse
      • SearchAllResponse
      • SearchRecentResponse
  • Contenido del módulo
    • PostsClient
      • PostsClient.__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()
• Paquete xdk.spaces
  • Submódulos
    • módulo xdk.spaces.client
      • SpacesClient
    • módulo xdk.spaces.models
      • GetBuyersResponse
      • GetByCreatorIdsResponse
      • GetByIdResponse
      • GetByIdsResponse
      • GetPostsResponse
      • SearchResponse
  • Contenido del módulo
    • SpacesClient
      • SpacesClient.__init__()
      • SpacesClient.get_buyers()
      • SpacesClient.get_by_creator_ids()
      • SpacesClient.get_by_id()
      • SpacesClient.get_by_ids()
      • SpacesClient.get_posts()
      • SpacesClient.search()
• Paquete xdk.stream
  • Submódulos
    • módulo xdk.stream.client
      • StreamClient
    • módulo xdk.stream.models
      • GetRuleCountsResponse
      • GetRulesResponse
      • LabelsComplianceResponse
      • LikesComplianceResponse
      • LikesFirehoseResponse
      • LikesSample10Response
      • PostsComplianceResponse
      • PostsFirehoseEnResponse
      • PostsFirehoseJaResponse
      • PostsFirehoseKoResponse
      • PostsFirehosePtResponse
      • PostsFirehoseResponse
      • PostsResponse
      • PostsSample10Response
      • PostsSampleResponse
      • UpdateRulesRequest
      • UpdateRulesResponse
      • UsersComplianceResponse
  • Contenido del módulo
    • 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()
• Paquete xdk.trends
  • Submódulos
    • módulo xdk.trends.client
      • TrendsClient
    • módulo xdk.trends.models
      • GetAiResponse
      • GetByWoeidResponse
      • GetPersonalizedResponse
  • Contenido del módulo
    • TrendsClient
      • TrendsClient.__init__()
      • TrendsClient.get_ai()
      • TrendsClient.get_by_woeid()
      • TrendsClient.get_personalized()
• Paquete xdk.usage
  • Submódulos
    • Módulo xdk.usage.client
      • UsageClient
    • Módulo xdk.usage.models
      • GetResponse
  • Contenido del módulo
    • UsageClient
      • UsageClient.__init__()
      • UsageClient.get()
• Paquete xdk.users
  • Submódulos
    • módulo xdk.users.client
      • UsersClient
    • módulo xdk.users.models
      • BlockDmsResponse
      • CreateBookmarkRequest
      • CreateBookmarkResponse
      • DeleteBookmarkResponse
      • FollowListRequest
      • FollowListResponse
      • FollowUserRequest
      • FollowUserResponse
      • GetBlockingResponse
      • GetBookmarkFoldersResponse
      • GetBookmarksByFolderIdResponse
      • GetBookmarksResponse
      • GetByIdResponse
      • GetByIdsResponse
      • GetByUsernameResponse
      • GetByUsernamesResponse
      • GetFollowedListsResponse
      • GetFollowersResponse
      • GetFollowingResponse
      • GetLikedPostsResponse
      • GetListMembershipsResponse
      • GetMeResponse
      • GetMentionsResponse
      • GetMutingResponse
      • GetOwnedListsResponse
      • GetPinnedListsResponse
      • GetPostsResponse
      • GetRepostsOfMeResponse
      • GetTimelineResponse
      • LikePostRequest
      • LikePostResponse
      • MuteUserRequest
      • MuteUserResponse
      • PinListRequest
      • PinListResponse
      • RepostPostRequest
      • RepostPostResponse
      • SearchResponse
      • UnblockDmsResponse
      • UnfollowListResponse
      • UnfollowUserResponse
      • UnlikePostResponse
      • UnmuteUserResponse
      • UnpinListResponse
      • UnrepostPostResponse
  • Contenido del módulo
    • UsersClient
      • UsersClient.__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()
• Paquete xdk.webhooks
  • Submódulos
    • módulo xdk.webhooks.client
      • WebhooksClient
    • módulo xdk.webhooks.models
      • CreateRequest
      • CreateResponse
      • CreateStreamLinkResponse
      • CreateWebhookReplayJobRequest
      • CreateWebhookReplayJobResponse
      • DeleteResponse
      • DeleteStreamLinkResponse
      • GetResponse
      • GetStreamLinksResponse
      • ValidateResponse
  • Contenido del módulo
    • WebhooksClient
      • WebhooksClient.__init__()
      • WebhooksClient.create()
      • WebhooksClient.create_stream_link()
      • WebhooksClient.create_webhook_replay_job()
      • WebhooksClient.delete()
      • WebhooksClient.delete_stream_link()
      • WebhooksClient.get()
      • WebhooksClient.get_stream_links()
      • WebhooksClient.validate()

​

Submódulos

• Módulo xdk.client
  • Client
    • Client.__init__()
    • Client.access_token
    • Client.exchange_code()
    • Client.fetch_token()
    • Client.get_authorization_url()
    • Client.is_token_expired()
    • Client.oauth2_session
    • Client.refresh_token()
    • Client.token
• Módulo xdk.oauth1_auth
  • OAuth1
    • OAuth1.__init__()
    • OAuth1.build_request_header()
    • OAuth1.get_access_token()
    • OAuth1.get_authorization_url()
    • OAuth1.get_request_token()
    • OAuth1.start_oauth_flow()
  • OAuth1AccessToken
    • OAuth1AccessToken.__init__()
  • OAuth1RequestToken
    • OAuth1RequestToken.__init__()
• Módulo xdk.oauth2_auth
  • OAuth2PKCEAuth
    • OAuth2PKCEAuth.__init__()
    • OAuth2PKCEAuth.access_token
    • OAuth2PKCEAuth.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()
• Módulo xdk.paginator
  • Cursor
    • Cursor.__init__()
    • Cursor.items()
    • Cursor.pages()
  • PaginatableMethod
    • PaginatableMethod.__init__()
  • PaginationError
  • cursor()
• Módulo xdk.streaming
  • StreamConfig
    • StreamConfig.max_retries
    • StreamConfig.initial_backoff
    • StreamConfig.max_backoff
    • StreamConfig.backoff_multiplier
    • StreamConfig.jitter
    • StreamConfig.timeout
    • StreamConfig.chunk_size
    • StreamConfig.on_connect
    • StreamConfig.on_disconnect
    • StreamConfig.on_reconnect
    • StreamConfig.on_error
    • StreamConfig.__init__()
    • StreamConfig.backoff_multiplier
    • StreamConfig.chunk_size
    • StreamConfig.initial_backoff
    • StreamConfig.jitter
    • StreamConfig.max_backoff
    • StreamConfig.max_retries
    • StreamConfig.on_connect
    • StreamConfig.on_disconnect
    • StreamConfig.on_error
    • StreamConfig.on_reconnect
    • StreamConfig.timeout
  • StreamError
    • StreamError.__init__()
    • StreamError.is_retryable
  • StreamErrorType
    • StreamErrorType.AUTHENTICATION_ERROR
    • StreamErrorType.CLIENT_ERROR
    • StreamErrorType.CONNECTION_ERROR
    • StreamErrorType.FATAL_ERROR
    • StreamErrorType.RATE_LIMITED
    • StreamErrorType.SERVER_ERROR
    • StreamErrorType.STREAM_INTERRUPTED
    • StreamErrorType.TIMEOUT
  • StreamState
    • StreamState.__init__()
    • StreamState.current_backoff
    • StreamState.is_connected
    • StreamState.last_error
    • StreamState.retry_count
    • StreamState.total_items_received
  • stream_with_retry()

​

Contenido del módulo

SDK XDK para Python.

Un SDK de Python para la X API que proporciona acceso sencillo 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

path.base_url · str · predeterminado: "'https://api.x.com'"

path.bearer_token · str or None · predeterminado: "None"

path.access_token · str or None · predeterminado: "None"

path.client_id · str or None · predeterminado: "None"

path.client_secret · str or None · predeterminado: "None"

path.redirect_uri · str or None · predeterminado: "None"

path.token · Dict[str, Any] or None · predeterminado: "None"

path.scope · str or List[str] or None · predeterminado: "None"

path.authorization_base_url · str · predeterminado: "'https://x.com/i'"

path.auth · OAuth1

​

__init__

Inicializa el cliente de la X API.

​

Parámetros

path.base_url · str · predeterminado: "'https://api.x.com'"

La URL base de la X API (el valor predeterminado es https://api.x.com).

path.bearer_token · str or None · predeterminado: "None"

El Bearer Token para la X API (autenticación solo de la aplicación, app-only).

path.access_token · str or None · predeterminado: "None"

El token de acceso OAuth2 para el contexto de usuario (se puede usar directamente como Bearer Token).

path.client_id · str or None · predeterminado: "None"

El ID de cliente para la X API (requerido para el flujo OAuth2 PKCE).

path.client_secret · str or None · predeterminado: "None"

El secreto de cliente para la X API.

path.redirect_uri · str or None · predeterminado: "None"

El URI de redirección para la autorización OAuth2.

path.token · Dict[str, Any] or None · predeterminado: "None"

Un diccionario de tokens OAuth2 existente (si está disponible). Si se proporciona, se extraerá access_token.

path.scope · str or List[str] or None · predeterminado: "None"

Cadena separada por espacios o lista de cadenas para los ámbitos de autorización OAuth2.

path.authorization_base_url · str · predeterminado: "'https://x.com/i'"

La URL base para la autorización OAuth2 (el valor predeterminado es https://x.com/i).

path.auth · OAuth1

Instancia de OAuth1 para autenticación OAuth1.0a.

​

exchange_code

Intercambiar el código de autorización por tokens (coincide con la API de TypeScript).

​

Parámetros

path.code · Any

El código de autorización del callback.

path.code_verifier · Any · predeterminado: "None"

Verificador de código opcional (usa el verificador almacenado si no se indica).

​

fetch_token

Obtiene un token mediante la URL de respuesta de autorización (método obsoleto).

​

Parámetros

path.authorization_response · Any

La URL completa de devolución de llamada recibida tras la autorización.

​

get_authorization_url

Obtiene la URL de autorización para el flujo PKCE de OAuth2.

​

Parámetros

path.state · Any · predeterminado: "None"

Parámetro de estado opcional por motivos de seguridad.

​

is_token_expired

Verifica si el token OAuth2 ha caducado.

​

refresh_token

Actualiza el token de OAuth 2.0.

​

class xdk.Cursor

[ResponseType]

​

Parámetros

path.method · PaginatableMethod

​

__init__

Inicializa el cursor.

​

Parámetros

path.method · PaginatableMethod

El método de la API que se llamará para cada página (debe admitir paginación)

​

items

Itera sobre los elementos individuales de las respuestas paginadas.

​

Parámetros

path.limit · int or None · predeterminado: "None"

Número máximo de elementos que se devolverán (None para sin límite)

​

Devuelve

IteratorAny

​

pages

Itera sobre páginas de resultados.

​

Parámetros

path.limit · int or None · predeterminado: "None"

Número máximo de páginas a devolver (None para sin límite)

​

Devuelve

IteratorResponseType

​

class xdk.StreamConfig

Configuración de conexiones de streaming con comportamiento de reintento.

​

Parámetros

path.max_retries · int · predeterminado: "10"

path.initial_backoff · float · predeterminado: "1.0"

path.max_backoff · float · predeterminado: "64.0"

path.backoff_multiplier · float · predeterminado: "2.0"

path.jitter · bool · predeterminado: "True"

path.timeout · float or None · predeterminado: "None"

path.chunk_size · int · predeterminado: "1024"

path.on_connect · Callable[[], None] or None · predeterminado: "None"

path.on_disconnect · Callable[[Exception or None], None] or None · predeterminado: "None"

path.on_reconnect · Callable[[int, float], None] or None · predeterminado: "None"

path.on_error · Callable[[[StreamError

​

__init__

​

Parámetros

path.max_retries · int · predeterminado: "10"

path.initial_backoff · float · predeterminado: "1.0"

path.max_backoff · float · predeterminado: "64.0"

path.backoff_multiplier · float · predeterminado: "2.0"

path.jitter · bool · predeterminado: "True"

path.timeout · float or None · predeterminado: "None"

path.chunk_size · int · predeterminado: "1024"

path.on_connect · Callable[[], None] or None · predeterminado: "None"

path.on_disconnect · Callable[[Exception or None], None] or None · predeterminado: "None"

path.on_reconnect · Callable[[int, float], None] or None · predeterminado: "None"

path.on_error · Callable[[[StreamError

​

on_error : Callable[[[StreamError]

​

exception xdk.StreamError

Excepción generada para errores de streaming con clasificación asociada.

​

Parámetros

path.message · str

path.error_type · StreamErrorType

​

__init__

​

Parámetros

path.message · str

path.error_type · StreamErrorType

​

class xdk.StreamErrorType

Clasificación de errores de streaming para tomar decisiones de reintento.

​

Parámetros

path.value · Any

​

class xdk.StreamState

Estado interno de una conexión de streaming.

​

Parámetros

path.retry_count · int · predeterminado: "0"

path.current_backoff · float · predeterminado: "1.0"

path.is_connected · bool · predeterminado: "False"

path.total_items_received · int · predeterminado: "0"

path.last_error · StreamError

​

__init__

​

Parámetros

path.retry_count · int · predeterminado: "0"

path.current_backoff · float · predeterminado: "1.0"

path.is_connected · bool · predeterminado: "False"

path.total_items_received · int · predeterminado: "0"

path.last_error · StreamError

​

last_error : [StreamError]

​

xdk.cursor

Crea un cursor con inferencia de tipos y validación correctas. Esta función de fábrica ayuda con la inferencia de tipos para que obtengas sugerencias de tipo correctas para la respuesta y valida que el método admita paginación tanto en el análisis estático como en tiempo de ejecución.

​

Parámetros

path.method · PaginatableMethod

El método de la API que se va a envolver (debe admitir paginación)