API Hop

ドキュメント

API Hop ドキュメント

Twitter API

統一された Twitter API でユーザープロフィールやタイムラインを照会し、X API v2 形式のレスポンスを取得します。

このサービスは、統一された Twitter REST API を提供します。呼び出し元は、一貫した X API v2 形式のレスポンス構造を受け取ります。

text
/v1/twitter

認証

すべての Twitter API エンドポイントに Bearer Token 認証が必要です。

http
Authorization: Bearer YOUR_API_KEY

ベースパス

API Base URL の下で、次の相対パスを呼び出してください。

text
GET https://api.apihop.ai/v1/twitter/users
GET https://api.apihop.ai/v1/twitter/users/{id}
GET https://api.apihop.ai/v1/twitter/users/{id}/tweets

レスポンスの構造

Twitter API の成功レスポンスは success/data では囲まれず、正規化された data、includes、meta フィールドを直接返します。

対応機能

  1. username しかわからない場合は、まずユーザー名によるユーザー取得を呼び出し、data.id を読み取ってください。
  2. data.id を使ってユーザータイムラインの取得を呼び出してください。
  3. タイムラインのレスポンスに投稿者のプロフィール情報が必要な場合は、expansions=author_id を指定してください。

正規化の規則

  • ユーザーのエンドポイントは、1 つのユーザーオブジェクトを返します:{ "data": { ... } }
  • タイムラインのエンドポイントは、ツイートの配列を返します:{ "data": [ ... ], "meta": { ... } }
  • expansions=author_id を指定すると、タイムラインのレスポンスに includes.users が含まれます
  • user.fields と tweet.fields は、取得する任意フィールドを制御します
  • ユーザーオブジェクトでは、常に id、name、username が保持されます
  • ツイートオブジェクトでは、常に id と text が保持されます

任意フィールド

user.fields

正規化に対応しているユーザーフィールド:

  • created_at
  • description
  • entities
  • location
  • pinned_tweet_id
  • profile_banner_url
  • profile_image_url
  • protected
  • public_metrics
  • url
  • verified
  • verified_type

tweet.fields

正規化に対応しているツイートフィールド:

  • attachments
  • author_id
  • conversation_id
  • created_at
  • edit_history_tweet_ids
  • entities
  • in_reply_to_user_id
  • lang
  • possibly_sensitive
  • public_metrics
  • referenced_tweets
  • source

デバッグ

  • すべてのレスポンスに X-Request-Id が含まれます
  • 呼び出しが失敗した場合、結果に異常が見られる場合、レート制限が返された場合は、この値を記録してください
  • 課金について問い合わせる場合は、X-Request-Id とリクエスト時刻を保持してください

エンドポイント