Introdução

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 primeiros passos.

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 Communities Lookup fornecendo um id, conforme mostrado abaixo (usando o id 1758747817642700922):

      curl --location 'https://api.x.com/2/communities/1758747817642700922' --header 'Authorization: ••••••'

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

{
    "data": {
        "access": "Público",
        "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": "Aberto",
        "name": "Comunidade de Anime"
    }
}

​

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	data (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 fornecido.
access	string	O nível de acesso da Comunidade. Pode ser um dos seguintes: * Public * Closed
join_policy	string	A política de participação da Comunidade. Pode ser uma das seguintes: * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	O número de membros que entraram na Comunidade.

​

Exemplo de solicitação

Você pode chamar o endpoint Communities Lookup com campos adicionais da comunidade, como mostrado abaixo (usando o id 1758747817642700922):

curl --location 'https://api.x.com/2/communities/1758747817642700922?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 em JSON como mostrado abaixo:

{
    "data": {
        "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.",
        "access": "Público",
        "member_count": 40369,
        "created_at": "2024-02-17T06:58:50.000Z",
        "join_policy": "Aberta",
        "name": "Comunidade de Anime",
        "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI="
    }
}