하위 패키지
- 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
하위 모듈
- 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()
모듈 내용
XDK Python SDK. A Python SDK for the X API that provides convenient access to the X API endpoints with type safety and authentication support.class xdk.Client
X API와 상호작용하기 위한 클라이언트입니다.
매개변수
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__
X API 클라이언트를 초기화합니다.
매개변수
str
default:"'https://api.x.com'"
X API의 기본 URL입니다(기본값은 https://api.x.com).
str or None
default:"None"
X API의 Bearer Token입니다(앱 전용 인증).
str or None
default:"None"
사용자 컨텍스트를 위한 OAuth 2.0 액세스 토큰입니다(Bearer Token으로 직접 사용 가능).
str or None
default:"None"
X API의 client ID입니다(OAuth 2.0 PKCE 흐름에 필요).
str or None
default:"None"
X API의 client secret입니다.
str or None
default:"None"
OAuth 2.0 인증을 위한 redirect URI입니다.
Dict[str, Any] or None
default:"None"
기존 OAuth 2.0 토큰 딕셔너리입니다(가능한 경우). 제공되면 access_token이 추출됩니다.
str or List[str] or None
default:"None"
OAuth 2.0 인증 스코프를 위한 공백으로 구분된 문자열 또는 문자열 목록입니다.
str
default:"'https://x.com/i'"
OAuth 2.0 인증을 위한 기본 URL입니다(기본값은 https://x.com/i).
OAuth1
OAuth 1.0a 인증을 위한 OAuth1 인스턴스입니다.
exchange_code
인증 코드를 토큰으로 교환합니다(TypeScript API와 일치).
매개변수
Any
콜백에서 받은 인증 코드입니다.
Any
default:"None"
선택적 code verifier입니다(제공되지 않으면 저장된 verifier를 사용).
fetch_token
인증 응답 URL을 사용하여 토큰을 가져옵니다(레거시 메서드).
매개변수
Any
인증 후 수신된 전체 콜백 URL입니다.
get_authorization_url
OAuth 2.0 PKCE 흐름을 위한 인증 URL을 가져옵니다.
매개변수
Any
default:"None"
보안을 위한 선택적 state 매개변수입니다.
is_token_expired
OAuth 2.0 토큰이 만료되었는지 확인합니다.
refresh_token
OAuth 2.0 토큰을 갱신합니다.
class xdk.Cursor
[ResponseType]
매개변수
PaginatableMethod
__init__
Initialize the cursor.
매개변수
PaginatableMethod
The API method to call for each page (must support pagination)
items
Iterate over individual items from paginated responses.
매개변수
int or None
default:"None"
Maximum number of items to return (None for unlimited)
반환값
IteratorAny
pages
Iterate over pages of responses.
매개변수
int or None
default:"None"
Maximum number of pages to return (None for unlimited)
반환값
IteratorResponseType
class xdk.StreamConfig
Configuration for streaming connections with retry behavior.
매개변수
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__
매개변수
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
Exception raised for streaming errors with classification.
매개변수
str
StreamErrorType
__init__
매개변수
str
StreamErrorType
class xdk.StreamErrorType
Classification of streaming errors for retry decisions.
매개변수
Any
class xdk.StreamState
Internal state for a streaming connection.
매개변수
int
default:"0"
float
default:"1.0"
bool
default:"False"
int
default:"0"
StreamError
__init__
매개변수
int
default:"0"
float
default:"1.0"
bool
default:"False"
int
default:"0"
StreamError
last_error : [StreamError]
xdk.cursor
Create a cursor with proper type inference and validation.
This factory function helps with type inference so you get proper
type hints for the response type, and validates that the method
supports pagination at both static analysis and runtime.
매개변수
PaginatableMethod
The API method to wrap (must support pagination)