Client

​

Sous-packages

• package xdk.account_activity
  • Sous-modules
    • module xdk.account_activity.client
      • AccountActivityClient
    • module xdk.account_activity.models
      • CreateReplayJobResponse
      • CreateSubscriptionRequest
      • CreateSubscriptionResponse
      • DeleteSubscriptionResponse
      • GetSubscriptionCountResponse
      • GetSubscriptionsResponse
      • ValidateSubscriptionResponse
  • Contenu du module
    • AccountActivityClient
      • AccountActivityClient.__init__()
      • AccountActivityClient.create_replay_job()
      • AccountActivityClient.create_subscription()
      • AccountActivityClient.delete_subscription()
      • AccountActivityClient.get_subscription_count()
      • AccountActivityClient.get_subscriptions()
      • AccountActivityClient.validate_subscription()
• package xdk.activity
  • Sous-modules
    • Module xdk.activity.client
      • ActivityClient
    • Module xdk.activity.models
      • CreateSubscriptionRequest
      • CreateSubscriptionResponse
      • DeleteSubscriptionResponse
      • GetSubscriptionsResponse
      • StreamResponse
      • UpdateSubscriptionRequest
      • UpdateSubscriptionResponse
  • Contenu du module
    • ActivityClient
      • ActivityClient.__init__()
      • ActivityClient.create_subscription()
      • ActivityClient.delete_subscription()
      • ActivityClient.get_subscriptions()
      • ActivityClient.stream()
      • ActivityClient.update_subscription()
• Package xdk.communities
  • Sous-modules
    • Module xdk.communities.client
      • CommunitiesClient
    • Module xdk.communities.models
      • GetByIdResponse
      • SearchResponse
  • Contenu du module
    • CommunitiesClient
      • CommunitiesClient.__init__()
      • CommunitiesClient.get_by_id()
      • CommunitiesClient.search()
• package xdk.community_notes
  • Sous-modules
    • Module xdk.community_notes.client
      • CommunityNotesClient
    • Module xdk.community_notes.models
      • CreateRequest
      • CreateResponse
      • DeleteResponse
      • EvaluateRequest
      • EvaluateResponse
      • SearchEligiblePostsResponse
      • SearchWrittenResponse
  • Contenu du module
    • CommunityNotesClient
      • CommunityNotesClient.__init__()
      • CommunityNotesClient.create()
      • CommunityNotesClient.delete()
      • CommunityNotesClient.evaluate()
      • CommunityNotesClient.search_eligible_posts()
      • CommunityNotesClient.search_written()
• package xdk.compliance
  • Sous-modules
    • Module xdk.compliance.client
      • ComplianceClient
    • Module xdk.compliance.models
      • CreateJobsRequest
      • CreateJobsResponse
      • GetJobsByIdResponse
      • GetJobsResponse
  • Contenu du module
    • ComplianceClient
      • ComplianceClient.__init__()
      • ComplianceClient.create_jobs()
      • ComplianceClient.get_jobs()
      • ComplianceClient.get_jobs_by_id()
• package xdk.connections
  • Sous-modules
    • Module xdk.connections.client
      • ConnectionsClient
    • Module xdk.connections.models
      • DeleteAllResponse
  • Contenu du module
    • ConnectionsClient
      • ConnectionsClient.__init__()
      • ConnectionsClient.delete_all()
• Sous-package xdk.direct_messages
  • Sous-modules
    • xdk.direct_messages.client module
      • DirectMessagesClient
    • xdk.direct_messages.models module
      • CreateByConversationIdRequest
      • CreateByConversationIdResponse
      • CreateByParticipantIdRequest
      • CreateByParticipantIdResponse
      • CreateConversationRequest
      • CreateConversationResponse
      • DeleteEventsResponse
      • GetEventsByConversationIdResponse
      • GetEventsByIdResponse
      • GetEventsByParticipantIdResponse
      • GetEventsResponse
  • Contenu du module
    • 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()
• Sous-package xdk.general
  • Sous-modules
    • module xdk.general.client
      • GeneralClient
    • module xdk.general.models
      • GetOpenApiSpecResponse
  • Contenu du module
    • GeneralClient
      • GeneralClient.__init__()
      • GeneralClient.get_open_api_spec()
• sous-package xdk.lists
  • Sous-modules
    • module xdk.lists.client
      • ListsClient
    • module xdk.lists.models
      • AddMemberRequest
      • AddMemberResponse
      • CreateRequest
      • CreateResponse
      • DeleteResponse
      • GetByIdResponse
      • GetFollowersResponse
      • GetMembersResponse
      • GetPostsResponse
      • RemoveMemberByUserIdResponse
      • UpdateRequest
      • UpdateResponse
  • Contenu du module
    • 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()
• Sous-package xdk.media
  • Sous-modules
    • module xdk.media.client
      • MediaClient
    • module xdk.media.models
      • AppendUploadRequest
      • AppendUploadResponse
      • CreateMetadataRequest
      • CreateMetadataResponse
      • CreateSubtitlesRequest
      • CreateSubtitlesResponse
      • DeleteSubtitlesRequest
      • DeleteSubtitlesResponse
      • FinalizeUploadResponse
      • GetAnalyticsResponse
      • GetByKeyResponse
      • GetByKeysResponse
      • GetUploadStatusResponse
      • InitializeUploadRequest
      • InitializeUploadResponse
      • UploadRequest
      • UploadResponse
  • Contenu du module
    • 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()
• package xdk.news
  • Sous-modules
    • Module xdk.news.client
      • NewsClient
    • Module xdk.news.models
      • GetResponse
      • SearchResponse
  • Contenu du module
    • NewsClient
      • NewsClient.__init__()
      • NewsClient.get()
      • NewsClient.search()
• Package xdk.posts
  • Sous-modules
    • Module xdk.posts.client
      • PostsClient
    • Module xdk.posts.models
      • CreateRequest
      • CreateResponse
      • DeleteResponse
      • GetAnalyticsResponse
      • GetByIdResponse
      • GetByIdsResponse
      • GetCountsAllResponse
      • GetCountsRecentResponse
      • GetInsights28hrResponse
      • GetInsightsHistoricalResponse
      • GetLikingUsersResponse
      • GetQuotedResponse
      • GetRepostedByResponse
      • GetRepostsResponse
      • HideReplyRequest
      • HideReplyResponse
      • SearchAllResponse
      • SearchRecentResponse
  • Contenu du module
    • 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()
• Sous-package xdk.spaces
  • Sous-modules
    • module xdk.spaces.client
      • SpacesClient
    • module xdk.spaces.models
      • GetBuyersResponse
      • GetByCreatorIdsResponse
      • GetByIdResponse
      • GetByIdsResponse
      • GetPostsResponse
      • SearchResponse
  • Contenu du module
    • SpacesClient
      • SpacesClient.__init__()
      • SpacesClient.get_buyers()
      • SpacesClient.get_by_creator_ids()
      • SpacesClient.get_by_id()
      • SpacesClient.get_by_ids()
      • SpacesClient.get_posts()
      • SpacesClient.search()
• Package xdk.stream
  • Sous-modules
    • Module xdk.stream.client
      • StreamClient
    • Module xdk.stream.models
      • GetRuleCountsResponse
      • GetRulesResponse
      • LabelsComplianceResponse
      • LikesComplianceResponse
      • LikesFirehoseResponse
      • LikesSample10Response
      • PostsComplianceResponse
      • PostsFirehoseEnResponse
      • PostsFirehoseJaResponse
      • PostsFirehoseKoResponse
      • PostsFirehosePtResponse
      • PostsFirehoseResponse
      • PostsResponse
      • PostsSample10Response
      • PostsSampleResponse
      • UpdateRulesRequest
      • UpdateRulesResponse
      • UsersComplianceResponse
  • Contenu du module
    • 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()
• package xdk.trends
  • Sous-modules
    • module xdk.trends.client
      • TrendsClient
    • module xdk.trends.models
      • GetAiResponse
      • GetByWoeidResponse
      • GetPersonalizedResponse
  • Contenu du module
    • TrendsClient
      • TrendsClient.__init__()
      • TrendsClient.get_ai()
      • TrendsClient.get_by_woeid()
      • TrendsClient.get_personalized()
• sous-package xdk.usage
  • Sous-modules
    • module xdk.usage.client
      • UsageClient
    • module xdk.usage.models
      • GetResponse
  • Contenu du module
    • UsageClient
      • UsageClient.__init__()
      • UsageClient.get()
• package xdk.users
  • Sous-modules
    • module xdk.users.client
      • UsersClient
    • Module 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
  • Contenu du module
    • 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()
• Package xdk.webhooks
  • Sous-modules
    • module xdk.webhooks.client
      • WebhooksClient
    • module xdk.webhooks.models
      • CreateRequest
      • CreateResponse
      • CreateStreamLinkResponse
      • CreateWebhookReplayJobRequest
      • CreateWebhookReplayJobResponse
      • DeleteResponse
      • DeleteStreamLinkResponse
      • GetResponse
      • GetStreamLinksResponse
      • ValidateResponse
  • Contenu du module
    • 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()

​

Sous-modules

• module 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
• Sous-module 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__()
• sous-module 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()
• Module xdk.paginator
  • Cursor
    • Cursor.__init__()
    • Cursor.items()
    • Cursor.pages()
  • PaginatableMethod
    • PaginatableMethod.__init__()
  • PaginationError
  • cursor()
• Module 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()

​

Contenu du module

XDK Python SDK.

Un SDK Python pour X API qui fournit un accès pratique aux endpoints de X API avec typage sécurisé et prise en charge de l’authentification.

​

class xdk.Client

Client pour interagir avec X API.

​

Paramètres

path.base_url · str · défaut: "'https://api.x.com'"

path.bearer_token · str or None · défaut: "None"

path.access_token · str or None · défaut: "None"

path.client_id · str or None · défaut: "None"

path.client_secret · str or None · défaut: "None"

path.redirect_uri · str or None · défaut: "None"

path.token · Dict[str, Any] or None · défaut: "None"

path.scope · str or List[str] or None · défaut: "None"

path.authorization_base_url · str · défaut: "'https://x.com/i'"

path.auth · OAuth1

​

__init__

Initialise le client X API.

​

Paramètres

path.base_url · str · défaut: "'https://api.x.com'"

L’URL de base de l’API X (par défaut : https://api.x.com).

path.bearer_token · str or None · défaut: "None"

Le Jeton Bearer pour l’API X (authentification en mode App-only).

path.access_token · str or None · défaut: "None"

Le jeton d’accès OAuth2 pour le contexte utilisateur (peut être utilisé directement comme Jeton Bearer).

path.client_id · str or None · défaut: "None"

L’id client pour l’API X (requis pour le flux OAuth2 PKCE).

path.client_secret · str or None · défaut: "None"

Le secret client pour l’API X.

path.redirect_uri · str or None · défaut: "None"

L’URI de redirection pour l’autorisation OAuth2.

path.token · Dict[str, Any] or None · défaut: "None"

Un dictionnaire de jetons OAuth2 existants (si disponible). S’il est fourni, access_token sera extrait.

path.scope · str or List[str] or None · défaut: "None"

Chaîne avec des valeurs séparées par des espaces ou liste de chaînes pour les scopes d’autorisation OAuth2.

path.authorization_base_url · str · défaut: "'https://x.com/i'"

L’URL de base pour l’autorisation OAuth2 (par défaut : https://x.com/i).

path.auth · OAuth1

Instance OAuth1 pour l’authentification OAuth1.0a.

​

exchange_code

Échange un code d’autorisation en jetons (correspond à l’API TypeScript).

​

Paramètres

path.code · Any

Le code d’autorisation renvoyé dans le callback.

path.code_verifier · Any · défaut: "None"

Code de vérification facultatif (utilise le vérificateur enregistré s’il n’est pas fourni).

​

fetch_token

Récupère le jeton à partir de l’URL de réponse d’autorisation (ancienne méthode).

​

Paramètres

path.authorization_response · Any

L’URL de rappel complète reçue après l’autorisation.

​

get_authorization_url

Récupère l’URL d’autorisation pour le flux OAuth2 PKCE.

​

Paramètres

path.state · Any · défaut: "None"

Paramètre d’état optionnel pour des raisons de sécurité.

​

is_token_expired

Vérifier si le jeton OAuth2 a expiré.

​

refresh_token

Actualiser le jeton OAuth2.

​

class xdk.Cursor

[ResponseType]

​

Paramètres

path.method · PaginatableMethod

​

__init__

Initialise le curseur.

​

Paramètres

path.method · PaginatableMethod

La méthode d’API à appeler pour chaque page (doit prendre en charge la pagination)

​

items

Itérez sur chaque élément des réponses paginées.

​

Paramètres

path.limit · int or None · défaut: "None"

Nombre maximal d’éléments à renvoyer (None pour aucune limite)

​

Renvoie

IteratorAny

​

pages

Itère sur les pages de résultats.

​

Paramètres

path.limit · int or None · défaut: "None"

Nombre maximal de pages à retourner (None pour aucune limite)

​

Renvoie

IteratorResponseType

​

class xdk.StreamConfig

Configuration des connexions de streaming avec gestion des nouvelles tentatives.

​

Paramètres

path.max_retries · int · défaut: "10"

path.initial_backoff · float · défaut: "1.0"

path.max_backoff · float · défaut: "64.0"

path.backoff_multiplier · float · défaut: "2.0"

path.jitter · bool · défaut: "True"

path.timeout · float or None · défaut: "None"

path.chunk_size · int · défaut: "1024"

path.on_connect · Callable[[], None] or None · défaut: "None"

path.on_disconnect · Callable[[Exception or None], None] or None · défaut: "None"

path.on_reconnect · Callable[[int, float], None] or None · défaut: "None"

path.on_error · Callable[[[StreamError

​

__init__

​

Paramètres

path.max_retries · int · défaut: "10"

path.initial_backoff · float · défaut: "1.0"

path.max_backoff · float · défaut: "64.0"

path.backoff_multiplier · float · défaut: "2.0"

path.jitter · bool · défaut: "True"

path.timeout · float or None · défaut: "None"

path.chunk_size · int · défaut: "1024"

path.on_connect · Callable[[], None] or None · défaut: "None"

path.on_disconnect · Callable[[Exception or None], None] or None · défaut: "None"

path.on_reconnect · Callable[[int, float], None] or None · défaut: "None"

path.on_error · Callable[[[StreamError

​

on_error : Callable[[[StreamError]

​

exception xdk.StreamError

Exception levée pour les erreurs de streaming assorties d’une classification.

​

Paramètres

path.message · str

path.error_type · StreamErrorType

​

__init__

​

Paramètres

path.message · str

path.error_type · StreamErrorType

​

class xdk.StreamErrorType

Classification des erreurs de streaming pour les décisions de réessai.

​

Paramètres

path.value · Any

​

class xdk.StreamState

État interne d’une connexion de streaming.

​

Paramètres

path.retry_count · int · défaut: "0"

path.current_backoff · float · défaut: "1.0"

path.is_connected · bool · défaut: "False"

path.total_items_received · int · défaut: "0"

path.last_error · StreamError

​

__init__

​

Paramètres

path.retry_count · int · défaut: "0"

path.current_backoff · float · défaut: "1.0"

path.is_connected · bool · défaut: "False"

path.total_items_received · int · défaut: "0"

path.last_error · StreamError

​

last_error : [StreamError]

​

xdk.cursor

Crée un curseur avec une inférence de types et une validation correctes. Cette fonction factory aide à l’inférence des types afin que vous disposiez d’annotations de type appropriées pour le type de réponse, et vérifie que la méthode prend en charge la pagination aussi bien lors de l’analyse statique qu’à l’exécution.

​

Paramètres

path.method · PaginatableMethod

La méthode de l’API à encapsuler (doit prendre en charge la pagination)