Client

​

サブパッケージ

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

​

サブモジュール

• 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
• 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__()
• 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()
• xdk.paginatorモジュール
  • Cursor
    • Cursor.__init__()
    • Cursor.items()
    • Cursor.pages()
  • PaginatableMethod
    • PaginatableMethod.__init__()
  • PaginationError
  • cursor()
• 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()

​

モジュール内容

XDK Python SDK。

X API のエンドポイントに型安全かつ認証付きで簡単にアクセスできる Python SDK です。

​

class xdk.Client

X API とやり取りするための Client です。

​

パラメータ

path.base_url · str · デフォルト: "'https://api.x.com'"

path.bearer_token · str or None · デフォルト: "None"

path.access_token · str or None · デフォルト: "None"

path.client_id · str or None · デフォルト: "None"

path.client_secret · str or None · デフォルト: "None"

path.redirect_uri · str or None · デフォルト: "None"

path.token · Dict[str, Any] or None · デフォルト: "None"

path.scope · str or List[str] or None · デフォルト: "None"

path.authorization_base_url · str · デフォルト: "'https://x.com/i'"

path.auth · OAuth1

​

__init__

X API クライアントを初期化します。

​

パラメーター

path.base_url · str · デフォルト: "'https://api.x.com'"

X API のベース URL (デフォルトは https://api.x.com) 。

path.bearer_token · str or None · デフォルト: "None"

X API 用のベアラートークン (App 単位の認証) 。

path.access_token · str or None · デフォルト: "None"

ユーザーコンテキスト用の OAuth2 アクセストークン (ベアラートークンとしてそのまま使用可能) 。

path.client_id · str or None · デフォルト: "None"

X API 用の client ID (OAuth2 PKCE フローで必須) 。

path.client_secret · str or None · デフォルト: "None"

X API 用の client secret。

path.redirect_uri · str or None · デフォルト: "None"

OAuth2 認可用のリダイレクト URI。

path.token · Dict[str, Any] or None · デフォルト: "None"

既存の OAuth2 トークン辞書 (利用可能な場合) 。指定された場合は access_token が抽出されます。

path.scope · str or List[str] or None · デフォルト: "None"

OAuth2 認可スコープを表すスペース区切り文字列、または文字列のリストです。

path.authorization_base_url · str · デフォルト: "'https://x.com/i'"

OAuth2 認可用のベース URL (デフォルトは https://x.com/i) 。

path.auth · OAuth1

OAuth1.0a 認証用の OAuth1 インスタンス。

​

exchange_code

認可コードをトークンに交換します (TypeScript API と一致) 。

​

パラメータ

path.code · Any

コールバックで受け取った認可コード。

path.code_verifier · Any · デフォルト: "None"

任意のコードベリファイア (指定されない場合は保存済みのベリファイアを使用します) 。

​

fetch_token

認可レスポンス URL からトークンを取得します (レガシーなメソッド) 。

​

パラメーター

path.authorization_response · Any

認可後に受け取ったコールバック URL 全体。

​

get_authorization_url

OAuth 2.0 PKCE フロー用の認可 URL を取得します。

​

パラメーター

path.state · Any · デフォルト: "None"

セキュリティ向上のためのオプションの state パラメーターです。

​

is_token_expired

OAuth2 トークンが有効期限切れかどうかを確認します。

​

refresh_token

OAuth2 トークンを更新します。

​

class xdk.Cursor

[ResponseType]

​

パラメータ

path.method · PaginatableMethod

​

__init__

カーソルを初期化します。

​

パラメーター

path.method · PaginatableMethod

各ページごとに呼び出す API メソッド (ページネーションに対応している必要があります)

​

items

ページネーションされたレスポンスから個々のアイテムを反復処理します。

​

パラメーター

path.limit · int or None · デフォルト: "None"

返す項目の最大数 (None の場合は無制限)

​

戻り値

IteratorAny

​

pages

レスポンスをページ単位で反復処理します。

​

パラメータ

path.limit · int or None · デフォルト: "None"

返されるページ数の最大値 (無制限にする場合は None)

​

戻り値

IteratorResponseType

​

class xdk.StreamConfig

再試行動作を含むストリーミング接続の構成。

​

パラメータ

path.max_retries · int · デフォルト: "10"

path.initial_backoff · float · デフォルト: "1.0"

path.max_backoff · float · デフォルト: "64.0"

path.backoff_multiplier · float · デフォルト: "2.0"

path.jitter · bool · デフォルト: "True"

path.timeout · float or None · デフォルト: "None"

path.chunk_size · int · デフォルト: "1024"

path.on_connect · Callable[[], None] or None · デフォルト: "None"

path.on_disconnect · Callable[[Exception or None], None] or None · デフォルト: "None"

path.on_reconnect · Callable[[int, float], None] or None · デフォルト: "None"

path.on_error · Callable[[[StreamError

​

__init__

​

パラメータ

path.max_retries · int · デフォルト: "10"

path.initial_backoff · float · デフォルト: "1.0"

path.max_backoff · float · デフォルト: "64.0"

path.backoff_multiplier · float · デフォルト: "2.0"

path.jitter · bool · デフォルト: "True"

path.timeout · float or None · デフォルト: "None"

path.chunk_size · int · デフォルト: "1024"

path.on_connect · Callable[[], None] or None · デフォルト: "None"

path.on_disconnect · Callable[[Exception or None], None] or None · デフォルト: "None"

path.on_reconnect · Callable[[int, float], None] or None · デフォルト: "None"

path.on_error · Callable[[[StreamError

​

on_error : Callable[[[StreamError]

​

exception xdk.StreamError

分類情報を含むストリーミングエラーに対して送出される例外です。

​

パラメータ

path.message · str

path.error_type · StreamErrorType

​

__init__

​

パラメータ

path.message · str

path.error_type · StreamErrorType

​

class xdk.StreamErrorType

再試行要否を判断するためのストリーミングエラーの分類。

​

パラメータ

path.value · Any

​

class xdk.StreamState

ストリーミング接続の内部状態を表します。

​

パラメーター

path.retry_count · int · デフォルト: "0"

path.current_backoff · float · デフォルト: "1.0"

path.is_connected · bool · デフォルト: "False"

path.total_items_received · int · デフォルト: "0"

path.last_error · StreamError

​

__init__

​

パラメータ

path.retry_count · int · デフォルト: "0"

path.current_backoff · float · デフォルト: "1.0"

path.is_connected · bool · デフォルト: "False"

path.total_items_received · int · デフォルト: "0"

path.last_error · StreamError

​

last_error : [StreamError]

​

xdk.cursor

適切な型推論とバリデーションを行うカーソルを作成します。 このファクトリ関数は型推論を支援し、レスポンスの型に対して 適切な型ヒントが得られるようにするとともに、そのメソッドが 静的解析時と実行時の両方でページネーションをサポートしていることを検証します。

​

パラメーター

path.method · PaginatableMethod

ラップする API メソッド (ページネーションをサポートしている必要があります)