メインコンテンツへスキップ
このモジュールは、X API とやり取りするための中核となる Client クラスを提供します。 すべてのサブクライアントを統括し、認証、セッション管理、 および OAuth 2.0 PKCE フローを処理します。すべての機能は OpenAPI 仕様から生成されています。

Client

クラス 基底クラス: object | None = None) X API とやり取りするための Client です。

コンストラクター

__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-only 認証)。
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 インスタンス。

パラメータ

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

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

OAuth 2.0 トークンを更新します。