Introducción

Este endpoint permite buscar y descubrir Comunidades en función de palabras clave.

El endpoint acepta una o más palabras clave como query. De forma predeterminada, una solicitud devolverá tanto Comunidades públicas como cerradas que coincidan con la query especificada.

Configuración de la cuenta

Para acceder a estos endpoints, necesitará:

• Una cuenta de desarrollador aprobada.
• Autenticarse usando las keys and tokens de una App de desarrollador que se encuentra dentro de un Project.

Obtenga más información sobre cómo obtener acceso a los endpoints de X API v2 en nuestra guía de introducción.

Introducción

​

Autenticación

Puede autenticar este endpoint con Contexto de usuario de OAuth 1.0a, [OAuth 2.0 App-Only](https://developer.x.com(/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token), o Código de autorización de OAuth 2.0 con PKCE.  

​

Realizar una solicitud

Puede invocar el endpoint Search Communities como se muestra a continuación:

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

Si la solicitud se realiza correctamente, deberías ver la respuesta JSON como se muestra a continuación:

{
   "data": [
       {
           "access": "Public",
           "description": "¡Bienvenido a la Comunidad de Anime! Donde los fanáticos del anime se reúnen para compartir sus series favoritas y hablar de todo lo relacionado con el anime.",
           "join_policy": "Open",
           "name": "Anime Community"
       },
       {
           "access": "Public",
           "description": "Únete y conversa sobre anime 🥰",
           "join_policy": "Open",
           "name": "Anime World 🌸"
       },
       {
           "access": "Public",
           "description": "¡Para todos los amantes y creadores de anime!",
           "join_policy": "Open",
           "name": "Anime"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

​

Campos de la Comunidad

Puede obtener data adicional asociada con una Comunidad especificando Campos de la Comunidad.

Los siguientes Campos de la Comunidad están disponibles:

Valor del campo	Type	Descripción
created_at	date (ISO 8601)	Fecha y hora de creación de la Comunidad.
id	string	El identificador único de la Comunidad.
name	string	El nombre de la Comunidad.
description	string	El texto de la descripción de la Comunidad, si corresponde.
access	string	El nivel de acceso de la Comunidad. Puede ser uno de: * Public * Closed
join_policy	string	La política de incorporación de la Comunidad. Puede ser una de: * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	El número de miembros que se han unido a la Comunidad.

​

Ejemplo de solicitud

Puede invocar el endpoint Search Communities con campos de comunidad adicionales, como se muestra a continuación:

      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: ••••••'

Respuesta de ejemplo

Si la solicitud se realiza correctamente, verás la respuesta JSON como se muestra a continuación:

{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "¡Bienvenidos a la Comunidad de Anime! Donde los fanáticos del anime se reúnen para compartir sus series favoritas y hablar de todo lo relacionado con el anime.",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 39915,
           "name": "Comunidad de Anime",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "Únete y conversa sobre anime 🥰",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 26019,
           "name": "Mundo del Anime 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "¡Para todos los amantes y creadores de anime!",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 5612,
           "name": "Anime",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}