oEmbed API

Você pode usar a oEmbed API para retornar programaticamente conteúdo incorporado, como Tweets e timelines. A resposta da oEmbed API retornará um snippet HTML que será reconhecido automaticamente quando o JavaScript de widget do X estiver incluído na página. Note que a API é recomendada para realizar tarefas em massa, e recomendamos usar nossa robusta ferramenta publish.x.com para incorporar conteúdo.

Timelines incorporadas
Tweets incorporados

O snippet HTML retornado será reconhecido automaticamente como uma timeline incorporada quando o JavaScript de widget do X estiver incluído na página.O endpoint oEmbed permite a personalização da aparência final de uma timeline incorporada definindo as propriedades correspondentes na marcação HTML a ser interpretada pelo JavaScript do X incluído por padrão na resposta HTML. O formato da marcação retornada pode mudar ao longo do tempo à medida que o X adiciona novos recursos ou ajusta sua representação de timeline.Para uma timeline do X especificada pela URL da timeline, em um formato JSON compatível com oEmbed. Timelines de usuário e list são suportadas. A marcação da timeline destina-se a ser armazenada em cache em seus servidores por até o tempo de cache sugerido especificado pela propriedade cache_age.

URL do Recurso

https://publish.x.com/oembed

Informações do Recurso


Formatos de resposta	JSON
Requer autenticação?	Não
Rate limited	Não

Parâmetros

Nome	Descrição	Exemplo
url	A URL da timeline do X a ser incorporada	* https://x.com/TwitterDev *https://x.com/TwitterDev/lists/national-parks
limit	Exibir até N itens, onde N é um valor entre 1 e 20 inclusive	6
maxwidth	Definir a largura máxima do widget. Deve estar entre 180 e 1200 inclusive	300
maxheight	Definir a altura máxima do widget. Deve ser maior que 200	400
omit_script	Não incluir um elemento script na resposta	1
lang	Um código de idioma suportado pelo X	es
theme	Quando definido como dark, a timeline é exibida com texto claro sobre fundo escuro	dark
chrome	Remove um componente de exibição da timeline com tokens separados por espaço * noheader - oculta o cabeçalho * nofooter - oculta o rodapé, se visível * noborders - remove todas as bordas: ao redor do widget, entre Tweets e dentro de um Tweet * noscrollbar - recorta e oculta a barra de rolagem da timeline, se visível * transparent - remove a cor de fundo	noheader%20nofooter
aria_polite	Definir um valor assertivo de ARIA live region politeness para Tweets adicionados a uma timeline	assertive
dnt	Quando definido como true, a timeline e sua página incorporada em seu site não são usadas para fins que incluem sugestões personalizadas e anúncios personalizados	true

Exemplos de requisição

curl --request GET --url 'https://publish.x.com/oembed?url=https%3A%2F%2Ftwitter.com%2FInterior%2Fstatus%2F507185938620219395'
twurl -H publish.x.com "/oembed?url=https://x.com/Interior/status/463440424141459456"

Exemplo de resposta

{
  "url": "https://x.com/TwitterDev",
  "title": "",
  "html": "<a class=\"twitter-timeline\" href=\"https://x.com/TwitterDev\">Tweets by TwitterDev</a>\n<script async src=\"//platform.x.com/widgets.js\" charset=\"utf-8\"></script>",
  "width": null,
  "height": null,
  "type": "rich",
  "cache_age": "3153600000",
  "provider_name": "Twitter",
  "provider_url": "https://x.com",
  "version": "1.0"
}

O snippet HTML retornado será reconhecido automaticamente como um Tweet incorporado quando o JavaScript de widget do X estiver incluído na página.O endpoint oEmbed permite personalização da aparência final de um Tweet incorporado definindo as propriedades correspondentes na marcação HTML a ser interpretada pelo JavaScript do X incluído por padrão na resposta HTML. O formato da marcação retornada pode mudar ao longo do tempo à medida que o X adiciona novos recursos ou ajusta sua representação de Tweet.A marcação fallback do Tweet destina-se a ser armazenada em cache em seus servidores por até o tempo de cache sugerido especificado pela propriedade cache_age.

URL do Recurso

https://publish.x.com/oembed

Informações do Recurso


Formatos de resposta	JSON
Requer autenticação?	Não
Rate limited	Não

Parâmetros

Nome	Padrão	Descrição
`url`obrigatório String		A URL do Tweet a ser incorporado
`maxwidth` Int `[220..550]`	`325`	A largura máxima de um Tweet renderizado em pixels inteiros. Um valor fornecido abaixo ou acima do intervalo permitido será retornado como a largura mínima ou máxima suportada respectivamente; o valor de largura ajustado será refletido na propriedade `width` retornada. Note que o X não suporta o parâmetro oEmbed `maxheight`. Tweets são fundamentalmente texto, e, portanto, de altura imprevisível que não pode ser escalada como uma imagem ou vídeo. Da mesma forma, a resposta oEmbed não fornecerá um valor para `height`. Implementações que precisam de alturas consistentes para Tweets devem consultar os parâmetros `hide_thread` e `hide_media` abaixo.
`hide_media` Boolean, String ou Int	`false`	Quando definido como `true`, `"t"`, ou `1`, links em um Tweet não são expandidos para prévias de foto, vídeo ou link.
`hide_thread` Boolean, String ou Int	`false`	Quando definido como `true`, `"t"`, ou `1`, uma versão colapsada do Tweet anterior em uma thread de conversa não será exibida quando o Tweet solicitado é em resposta a outro Tweet.
`omit_script` Boolean, String ou Int	`false`	Quando definido como `true`, `"t"`, ou `1`, o `<script>` responsável por carregar o `widgets.js` não será retornado. Suas páginas web devem incluir sua própria referência a `widgets.js` para uso em todos os widgets do X, incluindo Tweets incorporados.
`align` Enum `{left,right,center,none}`	`none`	Especifica se o Tweet incorporado deve ser alinhado à esquerda, direita ou centro na página em relação ao elemento pai.
`lang` Enum(Idioma)	`en`	Solicita HTML retornado e um Tweet renderizado no idioma X suportado por Tweets incorporados especificado.
`theme` Enum `{light, dark}`	`light`	Quando definido como `dark`, o Tweet é exibido com texto claro sobre fundo escuro.
`dnt` Boolean	`false`	Quando definido como `true`, o Tweet e sua página incorporada em seu site não são usados para fins que incluem sugestões personalizadas e anúncios personalizados.

Exemplos de requisição

curl --request GET --url 'https://publish.x.com/oembed?url=https%3A%2F%2Ftwitter.com%2Ftwiterdev'
twurl -H publish.x.com "/oembed?url=https://x.com/TwitterDev"

Exemplo de resposta

{
  "url": "https:\/\/twitter.com\/Interior\/status\/463440424141459456",
  "author_name": "US Department of the Interior",
  "author_url": "https:\/\/twitter.com\/Interior",
  "html": "<blockquote class=\"twitter-tweet\"><p lang=\"en\" dir=\"ltr\">Sunsets don&#39;t get much better than this one over <a href=\"https:\/\/twitter.com\/GrandTetonNPS?ref_src=twsrc%5Etfw\">@GrandTetonNPS<\/a>. <a href=\"https:\/\/twitter.com\/hashtag\/nature?src=hash&amp;ref_src=twsrc%5Etfw\">#nature<\/a> <a href=\"https:\/\/twitter.com\/hashtag\/sunset?src=hash&amp;ref_src=twsrc%5Etfw\">#sunset<\/a> <a href=\"http:\/\/t.co\/YuKy2rcjyU\">pic.x.com\/YuKy2rcjyU<\/a><\/p>&mdash; US Department of the Interior (@Interior) <a href=\"https:\/\/twitter.com\/Interior\/status\/463440424141459456?ref_src=twsrc%5Etfw\">May 5, 2014<\/a><\/blockquote>\n<script async src=\"https:\/\/platform.x.com\/widgets.js\" charset=\"utf-8\"><\/script>\n",
  "width": 550,
  "height": null,
  "type": "rich",
  "cache_age": "3153600000",
  "provider_name": "Twitter",
  "provider_url": "https:\/\/twitter.com",
  "version": "1.0"
}

Getting Started

Products

Fundamentals

Partners & Customers

Resources

oEmbed API

URL do Recurso

Informações do Recurso

Parâmetros

Exemplos de requisição

Exemplo de resposta

URL do Recurso

Informações do Recurso

Parâmetros

Exemplos de requisição

Exemplo de resposta

​URL do Recurso

​Informações do Recurso

​Parâmetros

​Exemplos de requisição

​Exemplo de resposta

​URL do Recurso

​Informações do Recurso

​Parâmetros

​Exemplos de requisição

​Exemplo de resposta

URL do Recurso

Informações do Recurso

Parâmetros

Exemplos de requisição

Exemplo de resposta

URL do Recurso

Informações do Recurso

Parâmetros

Exemplos de requisição

Exemplo de resposta