クイックスタート

このガイドでは、Filtered stream に接続してフィルタルールに一致する投稿をほぼリアルタイムで受信する方法を説明します。

前提条件始める前に以下が必要です:

開発者アカウント
App の Bearer Token(Developer Console の「Keys and tokens」で確認できます)

フィルタルールを作成する

ルールは受信する投稿を定義します。演算子を使ってキーワード、ハッシュタグ、ユーザーなどでマッチできます。ルール例: “cat” を含み画像がある投稿にマッチ:

cat has:images

ルールを組み立てる

ルール構文と演算子を学ぶ

ストリームにルールを追加する

rules エンドポイントを使用してルールを追加します。各投稿がどのルールに一致したかを識別するため、tag を含めます:

cURL

curl -X POST "https://api.x.com/2/tweets/search/stream/rules" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "add": [
      {"value": "cat has:images", "tag": "cats with images"}
    ]
  }'

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Filtered stream にルールを追加
response = client.filtered_stream.add_rules(
    add=[{"value": "cat has:images", "tag": "cats with images"}]
)

for rule in response.data:
    print(f"Rule added: {rule.id} - {rule.value}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

// Filtered stream にルールを追加
const response = await client.filteredStream.addRules({
  add: [{ value: "cat has:images", tag: "cats with images" }],
});

response.data?.forEach((rule) => {
  console.log(`Rule added: ${rule.id} - ${rule.value}`);
});

レスポンス:

{
  "data": [
    {
      "id": "1273026480692322304",
      "value": "cat has:images",
      "tag": "cats with images"
    }
  ],
  "meta": {
    "sent": "2024-01-15T10:30:00.000Z",
    "summary": {
      "created": 1,
      "not_created": 0,
      "valid": 1,
      "invalid": 0
    }
  }
}

ルールを確認する

アクティブなルールをすべて表示し、ルールが追加されたか確認します:

cURL

curl "https://api.x.com/2/tweets/search/stream/rules" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# アクティブなルールをすべて取得
response = client.filtered_stream.get_rules()

for rule in response.data:
    print(f"Active rule: {rule.id} - {rule.value}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

// アクティブなルールをすべて取得
const response = await client.filteredStream.getRules();

response.data?.forEach((rule) => {
  console.log(`Active rule: ${rule.id} - ${rule.value}`);
});

ストリームに接続する

永続接続を開いて一致する投稿を受信します:

cURL

curl "https://api.x.com/2/tweets/search/stream?\
tweet.fields=created_at,author_id&\
expansions=author_id&\
user.fields=username" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Filtered stream に接続
for post in client.filtered_stream.stream(
    tweet_fields=["created_at", "author_id"],
    expansions=["author_id"],
    user_fields=["username"]
):
    print(f"New post: {post.data.text}")
    print(f"Matching rules: {post.matching_rules}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

// Filtered stream に接続
const stream = client.filteredStream.stream({
  tweetFields: ["created_at", "author_id"],
  expansions: ["author_id"],
  userFields: ["username"],
});

for await (const post of stream) {
  console.log(`New post: ${post.data?.text}`);
  console.log(`Matching rules: ${post.matching_rules}`);
}

受信した投稿を処理する

一致する投稿は JSON オブジェクトとしてストリーミングされます:

{
  "data": {
    "id": "1234567890",
    "text": "Look at this cute cat! 🐱",
    "author_id": "9876543210",
    "created_at": "2024-01-15T10:35:00.000Z",
    "edit_history_tweet_ids": ["1234567890"]
  },
  "includes": {
    "users": [
      {
        "id": "9876543210",
        "username": "catperson"
      }
    ]
  },
  "matching_rules": [
    {
      "id": "1273026480692322304",
      "tag": "cats with images"
    }
  ]
}

matching_rules 配列には、定義したタグを用いて、投稿に一致したルールが表示されます。

ルールを削除する(オプション)

ID を指定してルールを削除します:

cURL

curl -X POST "https://api.x.com/2/tweets/search/stream/rules" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "delete": {
      "ids": ["1273026480692322304"]
    }
  }'

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# ID でルールを削除
response = client.filtered_stream.delete_rules(
    delete={"ids": ["1273026480692322304"]}
)
print(f"Deleted: {response.meta.summary.deleted}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

// ID でルールを削除
const response = await client.filteredStream.deleteRules({
  delete: { ids: ["1273026480692322304"] },
});
console.log(`Deleted: ${response.meta?.summary?.deleted}`);

接続を管理する

Keep-alive シグナル

ストリームは 20 秒ごとに空行 (\r\n) を送信します。20 秒間データや keep-alive を受信しない場合は再接続してください。

切断

Ctrl+C を押して接続を閉じるか、ターミナルウィンドウを閉じます。

接続数の制限

App あたり 1 つの接続のみ許可されます。新しい接続を開くと既存の接続が閉じられます。

次のステップ

ルールを組み立てる

ルール構文を学ぶ

演算子リファレンス

すべての利用可能な演算子

切断の処理

グレースフルに再接続

API リファレンス

エンドポイントの完全なドキュメント

Getting Started

Products

Fundamentals

Partners & Customers

Resources

クイックスタート

ルールを組み立てる

接続を管理する

次のステップ

ルールを組み立てる

演算子リファレンス

切断の処理

API リファレンス

ルールを組み立てる

​接続を管理する

​次のステップ

ルールを組み立てる

演算子リファレンス

切断の処理

API リファレンス

接続を管理する

次のステップ