Introduction

Cet endpoint vous permet de rechercher et de découvrir des Communautés à l’aide de mots-clés.

L’endpoint accepte un ou plusieurs mots-clés via le paramètre query. Par défaut, une requête renverra les Communautés publiques et fermées qui correspondent à la query spécifiée.

Configuration du compte

Pour accéder à ces endpoints, vous aurez besoin de :

• D’un compte développeur approuvé.
• De vous authentifier à l’aide des clés et des jetons d’une App développeur située dans un Project.

Pour en savoir plus sur l’accès aux endpoints de la X API v2, consultez notre guide de démarrage.

Pour commencer

​

Authentification

Vous pouvez authentifier cet endpoint avec Contexte utilisateur OAuth 1.0a, [OAuth 2.0 App-Only](https://developer.x.com(/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token), ou OAuth 2.0 Autorisation par code avec PKCE.  

​

Effectuer une requête

Vous pouvez appeler l’endpoint Search Communities comme indiqué ci-dessous :

      curl --location 'https://api.x.com/2/communities/search?query=anime' --header 'Authorization: ••••••'

Si la requête aboutit, vous devriez voir la réponse JSON comme ci-dessous :

{
   "data": [
       {
           "access": "Public",
           "description": "Bienvenue dans la Communauté Anime ! Où les fans d'anime se rassemblent pour partager leurs séries préférées et discuter de tout ce qui touche à l'anime.",
           "join_policy": "Open",
           "name": "Anime Community"
       },
       {
           "access": "Public",
           "description": "Rejoignez-nous et échangez sur l'anime 🥰",
           "join_policy": "Open",
           "name": "Anime World 🌸"
       },
       {
           "access": "Public",
           "description": "Pour tous les passionnés et créateurs d'anime !",
           "join_policy": "Open",
           "name": "Anime"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

​

Champs de Community

Vous pouvez récupérer des données supplémentaires associées à une Community en spécifiant les Community Fields.

Les Community Fields suivants sont disponibles :

Valeur du champ	Type	Description
created_at	date (ISO 8601)	Date et heure de création de la Community.
id	string	Identifiant unique de la Community.
name	string	Nom de la Community.
description	string	Texte de description de la Community, si fourni.
access	string	Niveau d’accès de la Community. Peut être l’un des suivants : * Public * Closed
join_policy	string	Politique d’adhésion de la Community. Peut être l’une des suivantes : * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	Nombre de membres ayant rejoint la Community.

​

Exemple de requête

Vous pouvez appeler l’endpoint Search Communities avec des community fields supplémentaires, comme indiqué ci-dessous :

      curl --location 'https://api.x.com/2/communities/search?query=anime&community.fields=access,created_at,description,id,join_policy,member_count,name' --header 'Authorization: ••••••'

Exemple de réponse

Si la requête aboutit, vous devriez voir la réponse JSON comme ci-dessous :

{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "Bienvenue dans la Communauté Anime ! Ici, les fans d'anime se retrouvent pour partager leurs séries préférées et discuter de tout ce qui touche à l'anime.",
           "join_policy": "Ouvert",
           "access": "Public",
           "member_count": 39915,
           "name": "Communauté Anime",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "Rejoignez-nous et échangez sur l'anime 🥰",
           "join_policy": "Ouvert",
           "access": "Public",
           "member_count": 26019,
           "name": "Monde de l'Anime 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "Pour tous les passionnés et créateurs d'anime !",
           "join_policy": "Ouvert",
           "access": "Public",
           "member_count": 5612,
           "name": "Anime",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}