Quickstart

Este guia mostra como se conectar ao filtered stream para receber Posts em quase tempo real que correspondam às suas regras de filtro.

Pré-requisitosAntes de começar, você precisará de:

Uma conta de desenvolvedor
O Bearer Token do seu App (encontrado no Developer Console em “Keys and tokens”)

Crie uma regra de filtro

Regras definem quais Posts receber. Use operadores para corresponder a palavras-chave, hashtags, usuários e muito mais.Exemplo de regra: Corresponde a Posts contendo “cat” com imagens:

cat has:images

Criar uma regra

Aprenda a sintaxe de regras e os operadores

Adicione a regra ao seu stream

Adicione sua regra usando o endpoint de regras. Inclua uma tag para identificar qual regra correspondeu a cada Post:

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")

# Adicionar uma regra ao 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" });

// Adicionar uma regra ao 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}`);
});

Resposta:

{
  "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
    }
  }
}

Verifique suas regras

Liste todas as regras ativas para confirmar que sua regra foi adicionada:

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")

# Obter todas as regras ativas
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" });

// Obter todas as regras ativas
const response = await client.filteredStream.getRules();

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

Conecte-se ao stream

Abra uma conexão persistente para receber Posts correspondentes:

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")

# Conectar ao 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" });

// Conectar ao 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}`);
}

Processe os Posts recebidos

Posts correspondentes são transmitidos como objetos 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"
    }
  ]
}

O array matching_rules mostra quais regras corresponderam ao Post, usando as tags que você definiu.

Excluir regras (opcional)

Remova regras pelo 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")

# Excluir regras por 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" });

// Excluir regras por ID
const response = await client.filteredStream.deleteRules({
  delete: { ids: ["1273026480692322304"] },
});
console.log(`Deleted: ${response.meta?.summary?.deleted}`);

Gerenciando sua conexão

Sinais keep-alive

O stream envia linhas em branco (\r\n) a cada 20 segundos. Se você não receber dados ou um keep-alive por 20 segundos, reconecte.

Desconectando

Pressione Ctrl+C para fechar a conexão ou feche a janela do terminal.

Limites de conexão

Apenas uma conexão por App é permitida. Abrir uma nova conexão fechará qualquer conexão existente.

Próximos passos

Criar uma regra

Aprenda a sintaxe de regras

Referência de operadores

Todos os operadores disponíveis

Lidando com desconexões

Reconecte com elegância

Referência da API

Documentação completa do endpoint

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Quickstart

Criar uma regra

Gerenciando sua conexão

Próximos passos

Criar uma regra

Referência de operadores

Lidando com desconexões

Referência da API

Criar uma regra

​Gerenciando sua conexão

​Próximos passos

Criar uma regra

Referência de operadores

Lidando com desconexões

Referência da API

Gerenciando sua conexão

Próximos passos