Skip to main content
X API v2 は、すべてのエンドポイントで一貫したパターンになるように設計されています。1 つのエンドポイントの動作を理解すれば、同じパターンをどこでも適用できます。

一貫したパターン

URL の構造

すべての v2 エンドポイントは予測可能なパターンに従います。
例:

レスポンスの構造

すべてのレスポンスは同じトップレベル構造を使用します。

ID の形式

すべての ID は言語互換性を確保するため文字列として返されます。

Fields と expansions

同じ fieldsexpansions パラメータが一貫して機能します。

オブジェクトのスキーマ

同じオブジェクトタイプは、どのエンドポイントが返しても同じフィールドを持ちます。
  • 検索から返される Post は、lookup から返される Post と同じフィールドを持ちます
  • followers から返される User は、search から返される User と同じフィールドを持ちます
  • 展開されたオブジェクトは、単独で取得したものと一致します

認証

すべてのエンドポイントは同じ認証メソッドを使用します。

エラー処理

エラーは一貫した形式に従います。
すべてのエラータイプを見る →

ページネーション

すべてのページネーション対応エンドポイントは同じトークンシステムを使用します。 ページネーションの詳細を見る →

命名規則

  • アメリカ英語のスペル(favoritesfavourites ではない)
  • フィールド名は snake_case(author_idcreated_at
  • 一貫した用語(fields では retweet_countrepost_count ではない)

空の値

値がないフィールドは、null として返されるのではなく省略されます。

Entity の一貫性

entities オブジェクトには、テキストから解析された entity のみが含まれます。
  • urls
  • hashtags
  • mentions
  • cashtags
Media と poll は entities ではなく attachments にあります。

これがあなたにとって意味するもの

一度学べば、どこでも使える

1 つのエンドポイントで学んだパターンは、すべてのエンドポイントに適用されます。

予測可能なレスポンス

同じオブジェクトタイプは API 全体で同じ構造を持ちます。

シンプルなコード

共通パターン向けの再利用可能な関数を構築できます。

デバッグが容易

一貫したエラー形式でトラブルシューティングが簡単になります。

不一致の報告

不一致を見つけましたか?お知らせください。