Introducción

Este endpoint te permite buscar y descubrir Communities según palabras clave.

El endpoint acepta una o varias palabras clave como consulta. De forma predeterminada, una solicitud devolverá Communities públicas y cerradas que coincidan con la consulta especificada.

Configuración de la cuenta

Para acceder a estos endpoints, necesitarás:

• Una cuenta de desarrollador aprobada.
• Autenticarte con las claves y los tokens de una App de desarrollador que se encuentra dentro de un Project.

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

Primeros pasos

​

Autenticación

Puedes autenticar este endpoint con Contexto de usuario de OAuth 1.0a, 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

Puedes 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 completa correctamente, deberías ver la respuesta JSON como se muestra a continuación:

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

​

Campos de la comunidad

Puedes obtener datos adicionales asociados con una comunidad especificando Community Fields.

Los siguientes Community Fields están disponibles:

Valor del campo	Tipo	Descripción
created_at	fecha (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 se proporciona.
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	La cantidad de miembros que se han unido a la comunidad.

​

Ejemplo de solicitud

Puedes llamar al endpoint Search Communities con campos adicionales de la comunidad, 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, deberías ver la respuesta JSON como se muestra a continuación:

{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "Welcome to the Anime Community! Where anime fans gather to share their favorite shows and discuss everything anime-related.",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 39915,
           "name": "Anime Community",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "Join and text about anime 🥰",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 26019,
           "name": "Anime World 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "For all anime lovers and creators!",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 5612,
           "name": "Anime",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}