Pular para o conteúdo principal
A versão mais recente da X API v2 é significativa. Por isso, dividimos esta seção de migração em algumas partes:
O que há de novo na X API v2Saiba mais sobre os novos endpoints e funcionalidades que lançamos na X API v2.
Pronto para migrar?Inicie sua migração com um conjunto de guias e instruções.
Guia de migração do formato de dadosSaiba como adaptar seus analisadores de dados que anteriormente funcionavam com os formatos de dados Standard v1.1 e Enterprise.
Mapa de endpoints da X APIVeja como os endpoints Standard v1.1 e Enterprise correspondem aos novos endpoints da X API v2.

O que é a X API v2?

A X API v2 é agora a principal X API e é onde estão focados o investimento e a inovação de produto. Fizemos parcerias com desenvolvedores para construir a próxima geração da X API a fim de atender melhor nossa diversa comunidade de desenvolvedores. Com base no feedback da comunidade, reconstruímos a API para contemplar um conjunto mais amplo de necessidades, introduzimos novos recursos e endpoints e aprimoramos a experiência do desenvolvedor. A X API v2 é agora a principal X API e é onde estão focados o investimento e a inovação de produto. Nos últimos anos, fizemos parcerias com desenvolvedores e reconstruímos a API para atender melhor a um conjunto mais amplo de necessidades, introduzir novos recursos e endpoints e melhorar a experiência do desenvolvedor. Estamos comprometidos em continuar a construir uma plataforma aberta para desenvolvedores e estamos animados para ver o que você vai criar com a X API v2.

Por que migrar?

A X API v2 foi construída sobre uma base moderna e mais sustentável e inclui tanto endpoints substitutos aprimorados para a Standard v1.1 e produtos Enterprise quanto funcionalidades totalmente novas. Recomendamos fortemente que os clientes das APIs legadas (v1.1 e Enterprise) comecem a migrar para a v2, pois pretendemos descontinuá-las eventualmente. Use a X API para acompanhar e analisar a conversa pública, interagir com pessoas no X e inovar. Nesta seção, discutiremos os endpoints e as funcionalidades.

Endpoints da v2

Você pode ver uma lista completa de endpoints da v2 e seus equivalentes anteriores à v2 no guia a seguir: Embora a maioria dos endpoints na X API v2 sejam substituições, introduzimos vários novos endpoints. Aqui estão alguns exemplos de novos endpoints que lançamos na v2:
  • Endpoints de Spaces para ajudar as pessoas a aproveitar melhor o X Spaces e permitir que desenvolvedores contribuam para moldar o futuro das conversas em áudio.
  • Ocultar respostas, que permite criar ferramentas que ajudam a limitar o impacto de respostas abusivas, inconvenientes ou enganosas em escala.
  • Novos endpoints de List que permitem fixar e desafixar Lists ou consultar as Lists fixadas de alguém.
  • Novos endpoints de conformidade em lote que permitem garantir que seus dados de usuário e de Tweet armazenados estejam em conformidade.

Nova funcionalidade

A X API v2 também inclui novos recursos que ajudarão você a extrair mais valor da X API. Muito do que é novo foi impulsionado pelo seu feedback e inclui certos recursos que antes eram reservados para clientes Enterprise. Algumas das melhorias na API incluem:

Descubra novos e atualizados objetos de resposta

Os seis objetos de dados a seguir estão disponíveis nos endpoints v2:
ObjectDescription
TweetO objeto Tweet tem uma longa lista de campos no nível raiz, como id, text e created_at. Objetos Tweet também são o objeto pai de vários objetos filho, incluindo user, media, poll e place.
UserO objeto de usuário contém metadados da conta de usuário da X que descrevem o usuário referenciado.
SpacesO objeto Space consiste em campos como state, host_id, is_ticketed e até lang.
ListsO objeto List contém informações básicas sobre a lista solicitada, incluindo description, member_count e owner_id.
MediaSe um Tweet contiver mídia (como imagens), o objeto media pode ser solicitado usando o parâmetro media.fields e inclui campos como media_key, type, url, preview_image_url e outros.
PollUma enquete incluída em um Tweet não é um objeto primário em nenhum endpoint, mas pode ser localizada e expandida no objeto Tweet.
PlaceO objeto place consiste em campos como place_id, o objeto geo, country_code e outros. Essas informações podem ser usadas para identificar Tweets e analisar Tweets por localização.
Saiba mais sobre como usar fields e expansions.

Flexibilidade para escolher quais objetos e fields você recebe

Ao fazer uma requisição a um endpoint GET, você receberá o objeto principal de data relacionado a esse endpoint, que incluirá um conjunto de fields padrão. Por exemplo, o objeto Tweet fornece os fields id e text como padrão. Se você quiser recuperar fields adicionais na sua requisição, será necessário usar os parâmetros fields e expansions. O parâmetro expansions permite recuperar objetos de dados relacionados, como o Tweet fixado de um usuário ou um objeto de mídia, enquanto os operadores de field permitem solicitar fields específicos dentro de objetos retornados além dos padrões. Aqui está uma lista completa de expansions que você pode solicitar com os diferentes endpoints da X API v2:
Objeto / RecursoExpansions disponíveis
Tweetsauthor_id, edit_history_tweet_ids, entities.mentions.username, in_reply_to_user_id, referenced_tweets.id, referenced_tweets.id.author_id, attachments.poll_ids, attachments.media_keys, geo.place_id
Userspinned_tweet_id
Spacesinvited_user_ids, speaker_ids, creator_id, host_ids, topic_ids
Saiba mais sobre como usar fields e expansions.

Novas métricas disponíveis em Tweets, usuários, Spaces e objetos de mídia

Mais metrics agora estão acessíveis em objetos de Tweet, usuário, Spaces, Lists e mídia. Essas metrics podem ser públicas ou privadas, e algumas podem ser detalhadas por contexto orgânico ou promovido para anúncios de Tweet. Saiba mais sobre as metrics disponíveis.
ObjectAvailable MetricsPublic MetricsPrivate MetricsOrganic MetricsPromoted Metrics
tweetsretweet_count✔️✔️✔️
quote_count✔️
like_count✔️✔️✔️
reply_count✔️✔️✔️
impression_count✔️✔️✔️
url_profile_clicks✔️✔️✔️
url_link_clicks✔️✔️✔️
userfollower_count✔️
userfollowing_count✔️
mediaview_count✔️
mediaplayback_0_count✔️
spaceparticipant_count✔️

Editar Tweets

Os endpoints da X API v2 fornecem metadata de Tweets editados. O recurso Edit Tweet foi introduzido inicialmente para testes entre funcionários da X em 1º de setembro de 2022. A partir dessa data, Tweets elegíveis podem ser editados por 30 minutos e até 5 vezes. Saiba mais sobre Edit Tweets. Usando a X API v2, um desenvolvedor pode verificar:
  • Se um Tweet era elegível para edição no momento da criação. Alguns Tweets, como aqueles com enquetes ou programados, não podem ser editados.
  • Tweets podem ser editados por 30 minutos e até 5 vezes. Para Tweets editáveis, é possível ver se ainda há tempo para editar e quantas edições adicionais são possíveis.
  • Se você está visualizando uma versão editada de um Tweet (na maioria dos casos, a API retornará a versão mais recente de um Tweet, a menos que uma versão anterior específica seja solicitada pelo Tweet ID).
  • Todo o histórico de edições do Tweet.
  • O engajamento atribuído a cada versão do Tweet.

Acompanhe conversas encadeadas

Um novo campo de Tweet ajuda a identificar a qual tópico de conversa um Tweet pertence. Um id de conversa é o id do Tweet que iniciou a conversa. Saiba mais sobre o rastreamento de conversas.

Pronto para migrar

Para usar os endpoints v2, você precisará do seguinte: Observe a importância de usar chaves e tokens de uma App dentro de um Projeto. Se você estiver usando chaves e tokens de uma App fora de um Projeto, não conseguirá fazer uma solicitação aos endpoints v2. Depois que tiver uma conta de desenvolvedor, você poderá configurar todos os itens acima no portal do desenvolvedor.

Autenticação

Com a nova API do X, você usará dois padrões de autenticação diferentes — Contexto de Usuário do OAuth 1.0a e OAuth 2.0 Bearer Token — para acessar diferentes endpoints. Cada um tem uma finalidade distinta ao fazer solicitações aos endpoints: Contexto de Usuário do OAuth 1.0a é necessário ao fazer uma solicitação em nome de um usuário do X OAuth 2.0 Bearer Token é necessário para fazer solicitações em nome da sua App de desenvolvedor

Ferramentas e código

Para ajudar você a começar e se familiarizar com os novos endpoints e recursos, temos algumas opções para acelerar seu trabalho:
  • Temos uma coleção do Postman da X que permite usar o cliente Postman para fazer requisições e se conectar a endpoints individuais. Esta é uma forma simples de testar a autenticação e experimentar os endpoints.
  • Também disponibilizamos uma lista de bibliotecas, tanto compatíveis com a X quanto de terceiros, em Ruby, Python, Node, Java e muitas outras. Para mais contexto, consulte nossa página de ferramentas e bibliotecas.

Migrando para endpoints atualizados

À medida que você começa a explorar os novos endpoints do Twitter v2, criamos uma série de guias de migração detalhados para ajudar você a comparar os recursos de cada endpoint atualizado em relação às versões anteriores:

Migrando para o novo formato de dados

Ao migrar de v1.1 ou Enterprise para v2, é importante entender que o formato em que os dados são entregues mudou significativamente. Adicionamos novos fields, modificamos a ordem dos fields e, em alguns casos, removemos elementos por completo. Para saber mais sobre essas mudanças, estamos desenvolvendo uma série de guias que ajudarão você a mapear os fields do formato de dados pré-v2 para os novos fields e a entender como solicitar esses novos fields. Você pode saber mais visitando a nossa seção de migração de formatos de dados neste hub de migração ou consultando nossos guias específicos de formato de dados:

O que vem a seguir?

Quem já usa a plataforma há algum tempo perceberá que muitos dos novos endpoints estão alinhados com os endpoints Standard v1.1 e Enterprise existentes. De fato, nossa intenção é que eles substituam as três versões no futuro. Preparamos uma tabela para ajudar você a entender como os endpoints da X API se relacionam com versões anteriores. Se quiser ver o que está por vir, visite nosso roadmap de produto. Também temos um changelog que você pode consultar para ver o que já lançamos.

O que devemos desenvolver a seguir?

À medida que ampliamos os recursos da X API v2, queremos continuar ouvindo você. Agradecemos e incentivamos seu feedback. Confira as ideias que já foram enviadas, apoie aquelas que atendem às suas necessidades e envie seu feedback também!
I