Introdução

Este endpoint permite pesquisar e descobrir Communities com base em palavras-chave.

O endpoint aceita uma ou mais palavras‑chave como query. Por padrão, uma solicitação retornará Communities públicas e fechadas que correspondam à query especificada.

Configuração da conta

Para acessar esses endpoints, você precisará de:

• Uma conta de desenvolvedor aprovada.
• Autenticar-se usando as chaves e tokens de um App de desenvolvedor que esteja dentro de um Projeto.

Saiba mais sobre como obter acesso aos endpoints da X API v2 em nosso guia de introdução.

Primeiros passos

​

Autenticação

Você pode autenticar este endpoint com Contexto de Usuário do 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 Authorization Code com PKCE.  

​

Fazendo uma solicitação

Você pode chamar o endpoint Search Communities conforme mostrado abaixo:

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

Se a solicitação for bem-sucedida, você verá a resposta JSON como mostrado abaixo:

{
   "data": [
       {
           "access": "Public",
           "description": "Bem-vindos à Comunidade de Anime! Onde fãs de anime se reúnem para compartilhar suas séries favoritas e discutir tudo relacionado a anime.",
           "join_policy": "Open",
           "name": "Anime Community"
       },
       {
           "access": "Public",
           "description": "Participe e converse sobre anime 🥰",
           "join_policy": "Open",
           "name": "Anime World 🌸"
       },
       {
           "access": "Public",
           "description": "Para todos os amantes e criadores de anime!",
           "join_policy": "Open",
           "name": "Anime"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

​

Campos de Comunidade

Você pode obter dados adicionais associados a uma comunidade especificando os Campos de Comunidade.

Os seguintes Campos de Comunidade estão disponíveis:

Valor do campo	Tipo	Descrição
created_at	date (ISO 8601)	Data e hora de criação da Comunidade.
id	string	O identificador exclusivo da Comunidade.
name	string	O nome da Comunidade.
description	string	O texto da descrição da Comunidade, se fornecida.
access	string	O nível de acesso da Comunidade. Pode ser um dos: * Public * Closed
join_policy	string	A política de ingresso da Comunidade. Pode ser uma das: * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	O número de membros que ingressaram na Comunidade.

​

Exemplo de solicitação

Você pode chamar o endpoint Search Communities com fields adicionais de comunidade, como mostrado abaixo:

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

Exemplo de resposta

Se a solicitação for bem-sucedida, você verá a resposta JSON conforme mostrado abaixo:

{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "Bem-vindos à Comunidade de Anime! Onde fãs de anime se reúnem para compartilhar seus shows favoritos e discutir tudo relacionado a anime.",
           "join_policy": "Aberta",
           "access": "Pública",
           "member_count": 39915,
           "name": "Comunidade de Anime",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "Junte-se e converse sobre anime 🥰",
           "join_policy": "Aberta",
           "access": "Pública",
           "member_count": 26019,
           "name": "Mundo do Anime 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "Para todos os amantes e criadores de anime!",
           "join_policy": "Aberta",
           "access": "Pública",
           "member_count": 5612,
           "name": "Anime",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}