Skip to main content

サブパッケージ

サブモジュール

モジュール内容

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

class xdk.Client

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

パラメータ

str
デフォルト:"'https://api.x.com'"
str or None
デフォルト:"None"
str or None
デフォルト:"None"
str or None
デフォルト:"None"
str or None
デフォルト:"None"
str or None
デフォルト:"None"
Dict[str, Any] or None
デフォルト:"None"
str or List[str] or None
デフォルト:"None"
str
デフォルト:"'https://x.com/i'"
OAuth1

__init__

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

パラメーター

str
デフォルト:"'https://api.x.com'"
X API のベース URL (デフォルトは https://api.x.com) 。
str or None
デフォルト:"None"
X API 用のベアラートークン (App 単位の認証) 。
str or None
デフォルト:"None"
ユーザーコンテキスト用の OAuth2 アクセストークン (ベアラートークンとしてそのまま使用可能) 。
str or None
デフォルト:"None"
X API 用の client ID (OAuth2 PKCE フローで必須) 。
str or None
デフォルト:"None"
X API 用の client secret。
str or None
デフォルト:"None"
OAuth2 認可用のリダイレクト URI。
Dict[str, Any] or None
デフォルト:"None"
既存の OAuth2 トークン辞書 (利用可能な場合) 。指定された場合は access_token が抽出されます。
str or List[str] or None
デフォルト:"None"
OAuth2 認可スコープを表すスペース区切り文字列、または文字列のリストです。
str
デフォルト:"'https://x.com/i'"
OAuth2 認可用のベース URL (デフォルトは https://x.com/i) 。
OAuth1
OAuth1.0a 認証用の OAuth1 インスタンス。

exchange_code

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

パラメータ

Any
コールバックで受け取った認可コード。
Any
デフォルト:"None"
任意のコードベリファイア (指定されない場合は保存済みのベリファイアを使用します) 。

fetch_token

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

パラメーター

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

get_authorization_url

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

パラメーター

Any
デフォルト:"None"
セキュリティ向上のためのオプションの state パラメーターです。

is_token_expired

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

refresh_token

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

class xdk.Cursor

[ResponseType]

パラメータ

PaginatableMethod

__init__

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

パラメーター

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

items

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

パラメーター

int or None
デフォルト:"None"
返す項目の最大数 (None の場合は無制限)

戻り値

IteratorAny

pages

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

パラメータ

int or None
デフォルト:"None"
返されるページ数の最大値 (無制限にする場合は None)

戻り値

IteratorResponseType

class xdk.StreamConfig

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

パラメータ

int
デフォルト:"10"
float
デフォルト:"1.0"
float
デフォルト:"64.0"
float
デフォルト:"2.0"
bool
デフォルト:"True"
float or None
デフォルト:"None"
int
デフォルト:"1024"
Callable[[], None] or None
デフォルト:"None"
Callable[[Exception or None], None] or None
デフォルト:"None"
Callable[[int, float], None] or None
デフォルト:"None"
Callable[[[StreamError

__init__

パラメータ

int
デフォルト:"10"
float
デフォルト:"1.0"
float
デフォルト:"64.0"
float
デフォルト:"2.0"
bool
デフォルト:"True"
float or None
デフォルト:"None"
int
デフォルト:"1024"
Callable[[], None] or None
デフォルト:"None"
Callable[[Exception or None], None] or None
デフォルト:"None"
Callable[[int, float], None] or None
デフォルト:"None"
Callable[[[StreamError

on_error : Callable[[[StreamError]

exception xdk.StreamError

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

パラメータ

str
StreamErrorType

__init__

パラメータ

str
StreamErrorType

class xdk.StreamErrorType

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

パラメータ

Any

class xdk.StreamState

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

パラメーター

int
デフォルト:"0"
float
デフォルト:"1.0"
bool
デフォルト:"False"
int
デフォルト:"0"
StreamError

__init__

パラメータ

int
デフォルト:"0"
float
デフォルト:"1.0"
bool
デフォルト:"False"
int
デフォルト:"0"
StreamError

last_error : [StreamError]

xdk.cursor

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

パラメーター

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