> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Inicio rápido
> Conéctate al stream filtrado para recibir Publicaciones en tiempo real
export const Button = ({href, children}) => {
return ;
};
Esta guía te explica cómo conectarte al stream filtrado para recibir en tiempo real Publicaciones que coincidan con tus reglas de filtrado.
**Requisitos previos**
Antes de comenzar, necesitarás lo siguiente:
* Una [cuenta de desarrollador](https://developer.x.com/en/portal/petition/essential/basic-info)
* El Bearer Token de tu App (se encuentra en la Consola de desarrollador, en «Keys and tokens»)
***
Las reglas definen qué Publicaciones se reciben. Usa operadores para hacer coincidir palabras clave, hashtags, usuarios y más.
**Ejemplo de regla:** Coincidir con Publicaciones que contengan "cat" y tengan imágenes:
```
cat has:images
```
Aprende la sintaxis de las reglas y sus operadores
Añade tu regla usando el endpoint de reglas. Incluye una `tag` para identificar qué regla se aplicó a cada Publicación:
```bash cURL theme={null}
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"}
]
}'
```
```python Python SDK theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Añade una regla al stream filtrado
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}")
```
```javascript JavaScript SDK theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Añade una regla al stream filtrado
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}`);
});
```
**Respuesta:**
```json theme={null}
{
"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
}
}
}
```
Lista todas las reglas activas para confirmar que se añadió tu regla:
```bash cURL theme={null}
curl "https://api.x.com/2/tweets/search/stream/rules" \
-H "Authorization: Bearer $BEARER_TOKEN"
```
```python Python SDK theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Obtener todas las reglas activas
response = client.filtered_stream.get_rules()
for rule in response.data:
print(f"Regla activa: {rule.id} - {rule.value}")
```
```javascript JavaScript SDK theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Obtener todas las reglas activas
const response = await client.filteredStream.getRules();
response.data?.forEach((rule) => {
console.log(`Regla activa: ${rule.id} - ${rule.value}`);
});
```
Abre una conexión persistente para recibir Publicaciones coincidentes:
```bash cURL theme={null}
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"
```
```python Python SDK theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Conéctate al stream filtrado
for post in client.filtered_stream.stream(
tweet_fields=["created_at", "author_id"],
expansions=["author_id"],
user_fields=["username"]
):
print(f"Nueva publicación: {post.data.text}")
print(f"Reglas coincidentes: {post.matching_rules}")
```
```javascript JavaScript SDK theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Conéctate al stream filtrado
const stream = client.filteredStream.stream({
tweetFields: ["created_at", "author_id"],
expansions: ["author_id"],
userFields: ["username"],
});
for await (const post of stream) {
console.log(`Nueva publicación: ${post.data?.text}`);
console.log(`Reglas coincidentes: ${post.matching_rules}`);
}
```
Flujo de Publicaciones que coinciden en forma de objetos JSON:
```json theme={null}
{
"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"
}
]
}
```
La matriz `matching_rules` muestra qué reglas se aplicaron a la Publicación, con las etiquetas que definiste.
Eliminar reglas por ID:
```bash cURL theme={null}
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"]
}
}'
```
```python SDK de Python theme={null}
from xdk import Client
client = Client(bearer_token="YOUR_BEARER_TOKEN")
# Eliminar reglas por ID
response = client.filtered_stream.delete_rules(
delete={"ids": ["1273026480692322304"]}
)
print(f"Deleted: {response.meta.summary.deleted}")
```
```javascript SDK de JavaScript theme={null}
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Eliminar reglas por ID
const response = await client.filteredStream.deleteRules({
delete: { ids: ["1273026480692322304"] },
});
console.log(`Deleted: ${response.meta?.summary?.deleted}`);
```
***
## Gestión de tu conexión
El flujo envía líneas en blanco (`\r\n`) cada 20 segundos. Si no recibes datos ni una señal de keep-alive durante 20 segundos, vuelve a conectarte.
Pulsa `Ctrl+C` para cerrar la conexión o cierra la ventana del terminal.
Solo se permite una conexión por App. Si abres una nueva conexión, se cerrará cualquier conexión existente.
***
## Próximos pasos
Aprende la sintaxis de las reglas
Todos los operadores disponibles
Vuelve a conectarte sin problemas
Documentación completa del endpoint