Python XDK

Python XDK は X API v2 向けの公式クライアントライブラリです。認証、ページネーション、ストリーミングを処理してくれるため、構築に集中できます。

GitHub リポジトリ

ソースコード、Issue、リリース。

インストール

pip install xdk

Python 3.8 以上が必要です。

クイックスタート

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Search for posts
for page in client.posts.search_recent(query="X API", max_results=10):
    if page.data and len(page.data) > 0:
        print(page.data[0].text)
        break

主な機能

機能	説明
OAuth サポート	Bearer Token、PKCE 付き OAuth 2.0、および OAuth 1.0a
自動ページネーション	手動で `next_token` を扱わずに結果を反復処理
ストリーミング	永続接続によるリアルタイムデータ (filtered stream など)
完全な API カバレッジ	X API v2 のすべてのエンドポイント — search、timelines、filtered stream ほか

認証

Bearer Token
OAuth 2.0
OAuth 1.0a

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

from xdk import Client
from xdk.oauth2_auth import OAuth2PKCEAuth

auth = OAuth2PKCEAuth(
    client_id="YOUR_CLIENT_ID",
    redirect_uri="YOUR_CALLBACK_URL",
    scope="tweet.read users.read offline.access"
)

auth_url = auth.get_authorization_url()
tokens = auth.fetch_token(authorization_response=callback_url)
client = Client(bearer_token=tokens["access_token"])

from xdk import Client
from xdk.oauth1_auth import OAuth1

oauth1 = OAuth1(
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET",
    access_token="YOUR_ACCESS_TOKEN",
    access_token_secret="YOUR_ACCESS_TOKEN_SECRET"
)

client = Client(auth=oauth1)

よく使うメソッド

カテゴリ	メソッド
Posts	`client.posts.search_recent()`
Users	`client.users.get_me()`
Spaces	`client.spaces.get()`
Lists	`client.lists.get()`
DMs	`client.direct_messages.get()`

さらに詳しく

インストール

開発用インストール、前提条件、動作確認。

クイックスタート

ステップバイステップの初回リクエストのウォークスルー。

認証

すべての認証方法の詳細ガイド。

ページネーション

自動ページネーションとイテレーター。

ストリーミング

filtered stream によるリアルタイムデータ。

API リファレンス

クライアントとモデルの完全リファレンス。

コード例については samples リポジトリを参照してください。

GitHub リポジトリ

​インストール

​クイックスタート

​主な機能

​認証

​よく使うメソッド

​さらに詳しく

インストール

クイックスタート

認証

ページネーション

ストリーミング

API リファレンス

インストール

クイックスタート

主な機能

認証

よく使うメソッド

さらに詳しく