> ## 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.

# Démarrage rapide

> Connectez-vous au flux filtré et recevez des Publications en temps réel

export const Button = ({href, children}) => {
  return <div className="not-prose group">
    <a href={href}>
      <button className="flex items-center space-x-2.5 py-1 px-4 bg-primary-dark dark:bg-white text-white dark:text-gray-950 rounded-full group-hover:opacity-[0.9] font-medium">
        <span>
          {children}
        </span>
        <svg width="3" height="24" viewBox="0 -9 3 24" class="h-6 rotate-0 overflow-visible"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg>
      </button>
    </a>
  </div>;
};

Ce guide vous explique comment vous connecter au flux filtré afin de recevoir en temps réel les Publications correspondant à vos règles de filtrage.

<Note>
  **Prérequis**

  Avant de commencer, vous aurez besoin de :

  * D'un [compte développeur](https://developer.x.com/en/portal/petition/essential/basic-info)
  * Du Jeton Bearer de votre App (disponible dans la Console de développement, sous « Keys and tokens »)
</Note>

***

<Steps>
  <Step title="Créer une règle de filtrage" icon="filter">
    Les règles déterminent les Publications à recevoir. Utilisez des opérateurs pour filtrer selon des mots-clés, des hashtags, des utilisateurs, et plus encore.

    **Exemple de règle :** correspond aux Publications contenant « cat » avec des images :

    ```
    cat has:images
    ```

    <Card title="Créer une règle" icon="filter" href="/fr/x-api/posts/filtered-stream/integrate/build-a-rule">
      Découvrez la syntaxe des règles et les opérateurs
    </Card>
  </Step>

  <Step title="Ajoutez la règle à votre flux" icon="plus">
    Ajoutez votre règle à l’aide du point de terminaison `rules`. Incluez un `tag` pour identifier quelle règle correspond à chaque Publication :

    <CodeGroup dropdown>
      ```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")

      # Ajouter une règle au flux filtré
      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" });

      // Ajouter une règle au flux filtré
      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}`);
      });
      ```
    </CodeGroup>

    **Réponse :**

    ```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
        }
      }
    }
    ```
  </Step>

  <Step title="Vérifiez vos règles" icon="check">
    Répertoriez toutes les règles actives pour confirmer que votre règle a bien été ajoutée :

    <CodeGroup dropdown>
      ```bash cURL theme={null}
      curl "https://api.x.com/2/tweets/search/stream/rules" \
        -H "Authorization: Bearer $BEARER_TOKEN"
      ```

      ```python SDK Python theme={null}
      from xdk import Client

      client = Client(bearer_token="YOUR_BEARER_TOKEN")

      # Récupérer toutes les règles actives
      response = client.filtered_stream.get_rules()

      for rule in response.data:
          print(f"Règle active : {rule.id} - {rule.value}")
      ```

      ```javascript SDK JavaScript theme={null}
      import { Client } from "@xdevplatform/xdk";

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

      // Récupérer toutes les règles actives
      const response = await client.filteredStream.getRules();

      response.data?.forEach((rule) => {
        console.log(`Règle active : ${rule.id} - ${rule.value}`);
      });
      ```
    </CodeGroup>
  </Step>

  <Step title="Connexion au flux" icon="plug">
    Ouvrez une connexion persistante pour recevoir les Publications correspondantes :

    <CodeGroup dropdown>
      ```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")

      # Se connecter au flux filtré
      for post in client.filtered_stream.stream(
          tweet_fields=["created_at", "author_id"],
          expansions=["author_id"],
          user_fields=["username"]
      ):
          print(f"Nouvelle publication : {post.data.text}")
          print(f"Règles correspondantes : {post.matching_rules}")
      ```

      ```javascript JavaScript SDK theme={null}
      import { Client } from "@xdevplatform/xdk";

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

      // Se connecter au flux filtré
      const stream = client.filteredStream.stream({
        tweetFields: ["created_at", "author_id"],
        expansions: ["author_id"],
        userFields: ["username"],
      });

      for await (const post of stream) {
        console.log(`Nouvelle publication : ${post.data?.text}`);
        console.log(`Règles correspondantes : ${post.matching_rules}`);
      }
      ```
    </CodeGroup>
  </Step>

  <Step title="Traiter les Publications entrantes" icon="message">
    Flux des Publications correspondantes, sous forme d’objets 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"
        }
      ]
    }
    ```

    <Tip>
      Le tableau `matching_rules` indique quelles règles se sont appliquées à la Publication, en utilisant les tags que vous avez définis.
    </Tip>
  </Step>

  <Step title="Supprimer des règles (facultatif)" icon="trash">
    Supprimer des règles par ID :

    <CodeGroup dropdown>
      ```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 Python theme={null}
      from xdk import Client

      client = Client(bearer_token="YOUR_BEARER_TOKEN")

      # Supprimer des règles par ID
      response = client.filtered_stream.delete_rules(
          delete={"ids": ["1273026480692322304"]}
      )
      print(f"Deleted: {response.meta.summary.deleted}")
      ```

      ```javascript SDK JavaScript theme={null}
      import { Client } from "@xdevplatform/xdk";

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

      # Supprimer des règles par ID
      const response = await client.filteredStream.deleteRules({
        delete: { ids: ["1273026480692322304"] },
      });
      console.log(`Deleted: ${response.meta?.summary?.deleted}`);
      ```
    </CodeGroup>
  </Step>
</Steps>

***

<div id="managing-your-connection">
  ## Gestion de votre connexion
</div>

<AccordionGroup>
  <Accordion title="Signaux de keep-alive">
    Le flux envoie des lignes vides (`\r\n`) toutes les 20 secondes. Si vous ne recevez aucune donnée ni de signal keep-alive pendant 20 secondes, reconnectez-vous.
  </Accordion>

  <Accordion title="Déconnexion">
    Appuyez sur `Ctrl+C` pour fermer la connexion, ou fermez votre fenêtre de terminal.
  </Accordion>

  <Accordion title="Limites de connexion">
    Une seule connexion par App est autorisée. L'ouverture d'une nouvelle connexion mettra fin à toute connexion existante.
  </Accordion>
</AccordionGroup>

***

<div id="next-steps">
  ## Prochaines étapes
</div>

<CardGroup cols={2}>
  <Card title="Créer une règle" icon="filter" href="/fr/x-api/posts/filtered-stream/integrate/build-a-rule">
    Découvrir la syntaxe des règles
  </Card>

  <Card title="Référence des opérateurs" icon="list-check" href="/fr/x-api/posts/filtered-stream/integrate/operators">
    Tous les opérateurs disponibles
  </Card>

  <Card title="Gestion des déconnexions" icon="plug" href="/fr/x-api/posts/filtered-stream/integrate/handling-disconnections">
    Se reconnecter en douceur
  </Card>

  <Card title="Référence de l’API" icon="code" href="/fr/x-api/posts/filtered-stream">
    Documentation complète du point de terminaison
  </Card>
</CardGroup>