API de oEmbed

La API de oEmbed devuelve HTML de incrustación sencillo en un formato compatible con oEmbed.

Puedes usar la API de oEmbed para recuperar de forma programática contenido incrustado, como Tweets y cronologías. 

La respuesta de la API de oEmbed será un fragmento de HTML que se reconocerá automáticamente cuando se incluya el JavaScript de widgets de X en la página.

Ten en cuenta que se recomienda usar la API para realizar tareas en lote, y te aconsejamos utilizar nuestra potente herramienta publish.x.com para incrustar contenido.

Cronologías incrustadas

El fragmento de HTML devuelto se reconocerá automáticamente como una cronología incrustada cuando se incluya el JavaScript de widgets de X en la página.

El endpoint oEmbed permite personalizar la apariencia final de una cronología incrustada estableciendo las propiedades correspondientes en el marcado HTML, que serán interpretadas por el JavaScript de X incluido de forma predeterminada en la respuesta HTML. El formato del marcado devuelto puede cambiar con el tiempo a medida que X añade nuevas funciones o ajusta su representación de cronologías.

Para una cronología de X especificada por la URL de la cronología, en un formato JSON compatible con oEmbed. Se admiten cronologías de usuario y de listas. El marcado de la cronología está pensado para almacenarse en caché en tus servidores hasta el tiempo de vida de caché sugerido especificado por la propiedad cache_age.

Resource URL

https://publish.x.com/oembed

Resource Information

Response formats	JSON
Requires authentication?	No
Rate limited	No

Parameters

Name	Description	Example
url	La URL de la cronología de X que se va a incrustar	* https://x.com/TwitterDev *https://x.com/TwitterDev/lists/national-parks
limit	Muestra hasta N elementos, donde N es un valor entre 1 y 20 inclusive	6
maxwidth	Establece el ancho máximo del widget. Debe estar entre 180 y 1200 inclusive	300
maxheight	Establece la altura máxima del widget. Debe ser mayor que 200	400
omit_script	No incluir un elemento script en la respuesta	1
lang	Un código de idioma compatible con X	es
theme	Cuando se establece en dark, la cronología se muestra con texto claro sobre un fondo oscuro	dark
chrome	Quita un componente de visualización de la cronología mediante tokens separados por espacios * noheader - oculta el encabezado * nofooter - oculta el pie de página, si es visible * noborders - elimina todos los bordes: alrededor del widget, entre Tweets y dentro de un Tweet * noscrollbar- recorta y oculta la barra de desplazamiento de la cronología, si es visible * transparent- elimina el color de fondo	noheader%20nofooter
aria_polite	Establece un valor de cortesía de región viva ARIA de nivel assertive para los Tweets añadidos a una cronología	assertive
dnt	Cuando se establece en true, la cronología y su página incrustada en tu sitio no se utilizan para fines que incluyen sugerencias personalizadas y anuncios personalizados	true

Example Requests

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"

Ejemplo de respuesta

{
  "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"
}

Tweets incrustados

El fragmento HTML devuelto se reconocerá automáticamente como un Tweet incrustado cuando se incluya el JavaScript del widget de X en la página.

El endpoint oEmbed permite personalizar la apariencia final de un Tweet incrustado mediante la configuración de las propiedades correspondientes en el marcado HTML, que serán interpretadas por el JavaScript de X incluido por defecto en la respuesta HTML. El formato del marcado devuelto puede cambiar con el tiempo a medida que X añade nuevas funcionalidades o ajusta la representación de sus Tweets.

El marcado de respaldo del Tweet debe almacenarse en caché en tus servidores durante el tiempo de vida de caché sugerido especificado por la propiedad cache_age.

URL del recurso

https://publish.x.com/oembed

Información del recurso

Formatos de respuesta	JSON
¿Requiere autenticación?	No
¿Está sujeto a límites de frecuencia?	No

Parámetros

Nombre	Predeterminado	Descripción
url obligatorio String		La URL del Tweet que se va a incrustar
maxwidth Int [220..550]	325	El ancho máximo de un Tweet renderizado en píxeles enteros. Un valor proporcionado por debajo o por encima del rango permitido se devolverá como el ancho mínimo o máximo admitido, respectivamente; el valor de ancho ajustado se reflejará en la propiedad width devuelta. Ten en cuenta que X no admite el parámetro oEmbed maxheight. Los Tweets son fundamentalmente texto y, por lo tanto, tienen una altura impredecible que no se puede escalar como una imagen o un video. Del mismo modo, la respuesta de oEmbed no proporcionará un valor para height. Las implementaciones que necesiten alturas consistentes para los Tweets deben usar los parámetros hide_thread y hide_media que se indican a continuación.
hide_media Boolean, String o Int	false	Cuando se establece en true, "t" o 1, los enlaces de un Tweet no se expanden a vistas previas de fotos, videos ni enlaces.
hide_thread Boolean, String o Int	false	Cuando se establece en true, "t" o 1, no se mostrará una versión contraída del Tweet anterior en un hilo de conversación cuando el Tweet solicitado sea una respuesta a otro Tweet.
omit_script Booleano, cadena o entero	false	Cuando se establece en true, "t" o 1, no se devolverá el <script> encargado de cargar widgets.js. Tus páginas web deben incluir su propia referencia a widgets.js para utilizarlo en todos los widgets de X, incluidos los Tweets incrustados.
align Enum {left,right,center,none}	none	Especifica si el Tweet incrustado debe alinearse a la izquierda, derecha o al centro de la página con respecto a su elemento padre.
lang Enum(Idioma)	en	La solicitud devuelve HTML y un Tweet renderizado en el idioma de X especificado compatible con Tweets incrustados.
theme Enum {light, dark}	light	Cuando se configura en dark, el Tweet se muestra con texto claro sobre un fondo oscuro.
dnt Booleano	false	Cuando se establece en true, el Tweet y su página incrustada en tu sitio no se utilizan con fines como las sugerencias personalizadas y los anuncios personalizados.

Ejemplos de solicitudes

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"

Respuesta de ejemplo

{
  "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=\"es\" dir=\"ltr\">Los atardeceres no pueden ser mucho mejores que este sobre <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\">#naturaleza<\/a> <a href=\"https:\/\/twitter.com\/hashtag\/sunset?src=hash&amp;ref_src=twsrc%5Etfw\">#atardecer<\/a> <a href=\"http:\/\/t.co\/YuKy2rcjyU\">pic.x.com\/YuKy2rcjyU<\/a><\/p>&mdash; Departamento del Interior de EE. UU. (@Interior) <a href=\"https:\/\/twitter.com\/Interior\/status\/463440424141459456?ref_src=twsrc%5Etfw\">5 de mayo de 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"
}