> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sorsa.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Guia de referência da API

# Referência completa: todos os endpoints da Sorsa

Todos os endpoints usam `https://api.sorsa.io/v3` e autenticação pelo cabeçalho `ApiKey`. Cada chamada consome uma requisição da cota. Contas novas incluem 100 requisições gratuitas, sem cartão.

A aba **Endpoints** inclui a referência interativa em português, com parâmetros, esquemas e exemplos. Você também pode testar pelo [API Playground](https://api.sorsa.io/playground).

## Dados de usuários

Perfis, seguidores, contas seguidas e metadados.

| Endpoint              | Método | Descrição                                                                                                             | Referência                                                                                            |
| :-------------------- | :----- | :-------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------- |
| `/info`               | GET    | Perfil completo de uma conta: bio, contadores, verificação e avatar. Aceita `username`, `user_id` ou `user_link`.     | [Referência](https://docs.sorsa.io/pt-br/api-reference/usu%C3%A1rios/perfil-do-usu%C3%A1rio)          |
| `/info-batch`         | GET    | Perfis de até 100 contas por chamada. Aceita `usernames[]` ou `user_ids[]`.                                           | [Referência](https://docs.sorsa.io/pt-br/api-reference/usu%C3%A1rios/perfis-de-usu%C3%A1rios-em-lote) |
| `/about`              | GET    | Metadados: país, quantidade e data de mudanças de nome, status e início do X Premium (Blue), origem e conta afiliada. | [Referência](https://docs.sorsa.io/pt-br/api-reference/usu%C3%A1rios/informa%C3%A7%C3%B5es-da-conta)  |
| `/followers`          | GET    | Seguidores paginados com perfis completos. Até 200 usuários por página.                                               | [Referência](https://docs.sorsa.io/pt-br/api-reference/usu%C3%A1rios/seguidores)                      |
| `/follows`            | GET    | Contas seguidas paginadas com perfis completos. Até 200 usuários por página.                                          | [Referência](https://docs.sorsa.io/pt-br/api-reference/usu%C3%A1rios/contas-seguidas)                 |
| `/verified-followers` | GET    | Lista paginada apenas de seguidores verificados.                                                                      | [Referência](https://docs.sorsa.io/pt-br/api-reference/usu%C3%A1rios/seguidores-verificados)          |

**Guias:** [Seguidores](https://docs.sorsa.io/pt-BR/followers-and-following) | [Localização da audiência](https://docs.sorsa.io/pt-BR/Audience-Geography) | [Concorrentes](https://docs.sorsa.io/pt-BR/Competitor-Analysis)

## Publicações

Conteúdo, métricas, respostas, citações, repostagens, artigos e tendências.

| Endpoint           | Método | Descrição                                                                                              | Referência                                                                                                                |
| :----------------- | :----- | :----------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |
| `/tweet-info`      | POST   | Dados completos de uma publicação: texto, métricas e autor. Corpo: `tweet_link`.                       | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/dados-da-publica%C3%A7%C3%A3o)               |
| `/tweet-info-bulk` | POST   | Dados de até 100 publicações. Corpo: `tweet_links[]`.                                                  | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/dados-de-publica%C3%A7%C3%B5es-em-lote)      |
| `/user-tweets`     | POST   | Timeline paginada de um usuário. Corpo: `user_link`, `username` ou `user_id`.                          | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/publica%C3%A7%C3%B5es-do-usu%C3%A1rio)       |
| `/comments`        | POST   | Respostas a uma publicação. Corpo: `tweet_link`; `order_by` opcional: `Relevance`, `Recency`, `Likes`. | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/coment%C3%A1rios-da-publica%C3%A7%C3%A3o)    |
| `/quotes`          | POST   | Citações de uma publicação. Corpo: `tweet_link`.                                                       | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/publica%C3%A7%C3%B5es-com-cita%C3%A7%C3%A3o) |
| `/retweeters`      | POST   | Usuários que repostaram; retorna perfis, não publicações. Corpo: `tweet_link`.                         | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/usu%C3%A1rios-que-repostaram)                |
| `/article`         | POST   | Conteúdo completo de um artigo do X. Corpo: `tweet_link`.                                              | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/dados-do-artigo)                             |
| `/trends`          | GET    | Tendências por localização. Consulta: `woeid` (Where On Earth IDentifier).                             | [Referência](https://docs.sorsa.io/pt-br/api-reference/publica%C3%A7%C3%B5es/tend%C3%AAncias)                             |

**Guias:** [Busca](https://docs.sorsa.io/pt-BR/search-tweets) | [Engajamento](https://docs.sorsa.io/pt-BR/tweet-engagement) | [Artigos](https://docs.sorsa.io/pt-BR/x-articles) | [Dados históricos](https://docs.sorsa.io/pt-BR/historical-data)

## Busca

Publicações, menções, perfis e informações sobre Spaces.

| Endpoint         | Método | Descrição                                                                                                                                               | Referência                                                                                    |
| :--------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------- |
| `/search-tweets` | POST   | Busca com os operadores do X. Corpo: `query`, `order`, `next_cursor`.                                                                                   | [Referência](https://docs.sorsa.io/pt-br/api-reference/busca/buscar-publica%C3%A7%C3%B5es)    |
| `/mentions`      | POST   | Menções a uma conta com filtros de data e engajamento. Corpo: `query`, `order`, `min_likes`, `min_retweets`, `min_replies`, `since_date`, `until_date`. | [Referência](https://docs.sorsa.io/pt-br/api-reference/busca/buscar-men%C3%A7%C3%B5es)        |
| `/search-users`  | POST   | Busca em bios, nomes públicos e nomes de usuário. Corpo: `query`.                                                                                       | [Referência](https://docs.sorsa.io/pt-br/api-reference/busca/buscar-usu%C3%A1rios)            |
| `/spaces`        | GET    | Dados de um Space: metadados, criador, participantes, configurações e métricas. Consulta: `id` ou `link`.                                               | [Referência](https://docs.sorsa.io/pt-br/api-reference/busca/informa%C3%A7%C3%B5es-de-spaces) |

**Guias:** [Busca de publicações](https://docs.sorsa.io/pt-BR/search-tweets) | [Menções](https://docs.sorsa.io/pt-BR/search-mentions) | [Operadores](https://docs.sorsa.io/pt-BR/search-operators) | [Público-alvo](https://docs.sorsa.io/pt-BR/target-audiences-Discovery)

## Verificação

Confira ações de usuários em campanhas e sorteios: seguir, repostar, comentar, citar e participar de comunidades.

| Endpoint                  | Método | Descrição                                                                                                                                                                      | Referência                                                                                                                   |
| :------------------------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- |
| `/check-follow`           | POST   | Verifica se `user_2` segue `user_1` (conta seguida). Corpo: um identificador para cada lado (`username_1`/`user_id_1`/`user_link_1` e `username_2`/`user_id_2`/`user_link_2`). | [Referência](https://docs.sorsa.io/pt-br/api-reference/verifica%C3%A7%C3%A3o/verificar-rela%C3%A7%C3%A3o-de-seguidores)      |
| `/check-comment`          | GET    | Verifica um comentário e retorna a publicação se encontrada. Consulta: `tweet_link` + `username`/`user_id`/`user_link`.                                                        | [Referência](https://docs.sorsa.io/pt-br/api-reference/verifica%C3%A7%C3%A3o/verificar-coment%C3%A1rio)                      |
| `/check-retweet`          | POST   | Verifica se um usuário repostou. Examina até 100 repostagens por requisição. Corpo: `tweet_link` + identificador do usuário.                                                   | [Referência](https://docs.sorsa.io/pt-br/api-reference/verifica%C3%A7%C3%A3o/verificar-repostagem)                           |
| `/check-quoted`           | POST   | Verifica citação ou repostagem. Retorna `status`: `quoted`, `retweet` ou `not_found`. Corpo: `tweet_link` + identificador do usuário.                                          | [Referência](https://docs.sorsa.io/pt-br/api-reference/verifica%C3%A7%C3%A3o/verificar-cita%C3%A7%C3%A3o-ou-repostagem)      |
| `/check-community-member` | POST   | Verifica participação em uma comunidade. Corpo: `community_id` + identificador do usuário.                                                                                     | [Referência](https://docs.sorsa.io/pt-br/api-reference/verifica%C3%A7%C3%A3o/verificar-participa%C3%A7%C3%A3o-na-comunidade) |
| `/check-shadowban`        | GET    | Verificações de visibilidade com resultados `clean`, `banned` ou `unknown`. Consulta: `username`. Confira a idade do cache em `checked_at`.                                    | [Referência](https://docs.sorsa.io/pt-br/api-reference/verifica%C3%A7%C3%A3o/verificar-shadowban)                            |

**Guia:** [Verificação de campanhas](https://docs.sorsa.io/pt-BR/Marketing-Campaign-Verification)

## Comunidades

Membros, publicações e busca dentro de comunidades do X.

| Endpoint                   | Método | Descrição                                                                              | Referência                                                                                                     |
| :------------------------- | :----- | :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
| `/community-tweets`        | POST   | Publicações de uma comunidade. Corpo: `community_id`, `order` (`popular` ou `latest`). | [Referência](https://docs.sorsa.io/pt-br/api-reference/comunidades/publica%C3%A7%C3%B5es-da-comunidade)        |
| `/community-search-tweets` | POST   | Busca em uma comunidade. Corpo: `community_link`, `query`, `order`.                    | [Referência](https://docs.sorsa.io/pt-br/api-reference/comunidades/buscar-publica%C3%A7%C3%B5es-na-comunidade) |
| `/community-members`       | POST   | Membros de uma comunidade com perfis. Corpo: `community_link`.                         | [Referência](https://docs.sorsa.io/pt-br/api-reference/comunidades/membros-da-comunidade)                      |

**Guia:** [Listas e comunidades](https://docs.sorsa.io/pt-BR/lists-and-communities)

## Listas

Perfis de membros, seguidores da lista e feed combinado.

| Endpoint          | Método | Descrição                                                           | Referência                                                                                    |
| :---------------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------- |
| `/list-members`   | GET    | Perfis das contas de uma lista. Consulta: `list_id`.                | [Referência](https://docs.sorsa.io/pt-br/api-reference/listas/membros-da-lista)               |
| `/list-followers` | GET    | Perfis de quem segue uma lista. Consulta: `list_link`.              | [Referência](https://docs.sorsa.io/pt-br/api-reference/listas/seguidores-da-lista)            |
| `/list-tweets`    | GET    | Publicações recentes dos membros de uma lista. Consulta: `list_id`. | [Referência](https://docs.sorsa.io/pt-br/api-reference/listas/publica%C3%A7%C3%B5es-da-lista) |

**Guias:** [Listas e comunidades](https://docs.sorsa.io/pt-BR/lists-and-communities) | [Monitoramento em tempo real](https://docs.sorsa.io/pt-BR/real-time-monitoring)

## Sorsa Score e análises de cripto

Pontuação de influência, categorias de seguidores e novas conexões entre contas cripto na base da Sorsa. Aceitam `username`, `user_id` ou `user_link`.

| Endpoint            | Método | Descrição                                                                        | Referência                                                                                                              |
| :------------------ | :----- | :------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- |
| `/score`            | GET    | Sorsa Score atual, métrica de influência em cripto.                              | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/sorsa-score)                                      |
| `/score-changes`    | GET    | Variação da pontuação na última semana e no último mês.                          | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/varia%C3%A7%C3%A3o-do-sorsa-score)                |
| `/followers-stats`  | GET    | Seguidores por categoria: influenciadores, projetos e fundos de venture capital. | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/estat%C3%ADsticas-por-categoria-de-seguidores)    |
| `/top-followers`    | GET    | 20 principais seguidores por Sorsa Score; cada item inclui a pontuação.          | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/20-seguidores-com-maior-pontua%C3%A7%C3%A3o)      |
| `/top-following`    | GET    | 20 principais contas seguidas por Sorsa Score.                                   | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/20-contas-seguidas-com-maior-pontua%C3%A7%C3%A3o) |
| `/new-followers-7d` | GET    | Contas cripto que passaram a seguir o usuário nos últimos 7 dias.                | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/novos-seguidores-em-7-dias)                       |
| `/new-following-7d` | GET    | Contas cripto que o usuário começou a seguir nos últimos 7 dias.                 | [Referência](https://docs.sorsa.io/pt-br/api-reference/sorsa-e-cripto/novas-contas-seguidas-em-7-dias)                  |

**Guia:** [Sorsa Score e análises de cripto](https://docs.sorsa.io/pt-BR/sorsa-score-and-crypto-analytics)

## Utilitários técnicos

Conversão de IDs e consulta do consumo da chave.

| Endpoint                        | Método | Descrição                                                           | Referência                                                                                                    |
| :------------------------------ | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------ |
| `/username-to-id/{user_handle}` | GET    | Converte nome de usuário em ID permanente.                          | [Referência](https://docs.sorsa.io/pt-br/api-reference/utilit%C3%A1rios/converter-nome-de-usu%C3%A1rio-em-id) |
| `/id-to-username/{user_id}`     | GET    | Converte ID em nome de usuário atual.                               | [Referência](https://docs.sorsa.io/pt-br/api-reference/utilit%C3%A1rios/converter-id-em-nome-de-usu%C3%A1rio) |
| `/link-to-id`                   | GET    | Extrai ID de uma URL de perfil. Consulta: `link`.                   | [Referência](https://docs.sorsa.io/pt-br/api-reference/utilit%C3%A1rios/converter-link-de-perfil-em-id)       |
| `/key-usage-info`               | GET    | Consumo atual, cota restante e vencimento do saldo. Sem parâmetros. | [Referência](https://docs.sorsa.io/pt-br/api-reference/utilit%C3%A1rios/uso-da-chave-de-api)                  |

**Guias:** [Conversão de IDs](https://docs.sorsa.io/pt-BR/ID-Conversion) | [Preços](https://docs.sorsa.io/pt-BR/pricing)

## Modelos de dados

Os principais objetos estão abaixo. Consulte variantes, tipos e casos especiais em [formato de resposta](https://docs.sorsa.io/pt-BR/response-format).

### Objeto User

Retornado por `/info`, `/info-batch`, seguidores, contas seguidas e busca de usuários, e incluído em cada publicação como `user`. Alguns endpoints cripto acrescentam `followerDate`; `/followers` e `/follows` usam User padrão.

| Campo                          | Tipo      | Descrição                                           |
| :----------------------------- | :-------- | :-------------------------------------------------- |
| `id`                           | string    | ID permanente (Snowflake)                           |
| `username`                     | string    | Nome de usuário atual, sem @                        |
| `display_name`                 | string    | Nome público do perfil                              |
| `description`                  | string    | Bio da conta                                        |
| `location`                     | string    | Localização informada pelo usuário (texto livre)    |
| `created_at`                   | string    | Data e hora de criação                              |
| `followers_count`              | integer   | Quantidade de seguidores                            |
| `followings_count`             | integer   | Quantidade de contas seguidas                       |
| `favourites_count`             | integer   | Total de curtidas dadas pela conta                  |
| `tweets_count`                 | integer   | Total de publicações                                |
| `media_count`                  | integer   | Total de itens de mídia publicados                  |
| `verified`                     | boolean   | Status de verificação (selo azul, dourado ou cinza) |
| `protected`                    | boolean   | Se a conta é privada                                |
| `can_dm`                       | boolean   | Se mensagens diretas estão abertas                  |
| `possibly_sensitive`           | boolean   | Se a conta tem marcação de conteúdo sensível        |
| `profile_image_url`            | string    | URL do avatar                                       |
| `profile_background_image_url` | string    | URL do banner                                       |
| `bio_urls`                     | string\[] | URLs da bio                                         |
| `pinned_tweet_ids`             | string\[] | IDs de publicações fixadas                          |

### Objeto Tweet

Retornado por `/tweet-info`, `/search-tweets`, `/user-tweets`, `/comments`, `/quotes`, `/mentions`, `/list-tweets` e endpoints de publicações de comunidades.

| Campo                  | Tipo           | Descrição                                                   |
| :--------------------- | :------------- | :---------------------------------------------------------- |
| `id`                   | string         | ID permanente (Snowflake)                                   |
| `full_text`            | string         | Texto completo da publicação                                |
| `created_at`           | string         | Data e hora de criação                                      |
| `lang`                 | string         | Código do idioma detectado, como en, ja ou es               |
| `likes_count`          | integer        | Total de curtidas                                           |
| `retweet_count`        | integer        | Total de repostagens                                        |
| `reply_count`          | integer        | Total de respostas                                          |
| `quote_count`          | integer        | Total de citações                                           |
| `bookmark_count`       | integer        | Total de salvamentos                                        |
| `view_count`           | integer        | Total de visualizações                                      |
| `conversation_id_str`  | string         | ID da publicação inicial da conversa                        |
| `in_reply_to_tweet_id` | string         | ID da publicação respondida                                 |
| `in_reply_to_username` | string         | Nome de usuário da conta respondida                         |
| `is_reply`             | boolean        | Se a publicação é uma resposta                              |
| `is_quote_status`      | boolean        | Se a publicação cita outra                                  |
| `is_replies_limited`   | boolean        | Se o autor restringiu as respostas                          |
| `made_with_ai`         | boolean        | Marcação de conteúdo criado com IA                          |
| `paid_partnership`     | boolean        | Parceria paga (conteúdo de marca)                           |
| `user`                 | User           | Perfil completo do autor                                    |
| `entities`             | TweetEntity\[] | Mídias e links anexados                                     |
| `quoted_status`        | Tweet          | Publicação citada (objeto completo e recursivo)             |
| `retweeted_status`     | Tweet          | Publicação original repostada (objeto completo e recursivo) |

### Objeto TweetEntity

| Campo     | Tipo   | Descrição                                   |
| :-------- | :----- | :------------------------------------------ |
| `type`    | string | Tipo de entidade: `photo`, `video` ou `url` |
| `link`    | string | Link direto (URL t.co)                      |
| `preview` | string | URL da imagem de prévia ou miniatura        |

## Padrões comuns

**Autenticação:** toda requisição exige `ApiKey`. Veja [autenticação](https://docs.sorsa.io/pt-BR/authentication).

**Paginação:** envie o `next_cursor` anterior e pare quando estiver ausente ou nulo. Consultas em lote e listas cripto como `/top-followers` não usam cursor. Veja [paginação](https://docs.sorsa.io/pt-BR/pagination).

**Erros:** retornam `{ "message": "..." }` com códigos `400`, `401`, `403`, `404`, `429` ou `500`. Veja [códigos de erro](https://docs.sorsa.io/pt-BR/error-codes).

**Limite:** 20 requisições por segundo nos planos padrão. Veja [limites](https://docs.sorsa.io/pt-BR/rate-limits).

**Entradas:** a maioria dos endpoints de usuários aceita `username`, `user_id` ou `user_link`. Envie exatamente um identificador.

## Próximos passos

* [Início rápido](https://docs.sorsa.io/pt-BR/quickstart): primeira chamada.
* [Formato de resposta](https://docs.sorsa.io/pt-BR/response-format): tipos, nulos e esquemas.
* [Operadores de busca](https://docs.sorsa.io/pt-BR/search-operators): consultas avançadas.
* [Otimização](https://docs.sorsa.io/pt-BR/optimizing-api-usage): lotes, deduplicação e cache.
