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

# oEmbed API

> Retorna um HTML embed simples para uma timeline do X especificada pela URL da timeline, em um formato JSON compatível com oEmbed. Timelines de usuário, list, likes e collection.

Retorna um HTML embed simples para uma timeline do X especificada pela URL da timeline, em um formato JSON compatível com [oEmbed](https://oembed.com/). Timelines de usuário, list, likes e collection 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

| Recurso              | Valor |
| -------------------- | ----- |
| 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/XDevelopers`<br />`https://x.com/XDevelopers/lists/national-parks` |
| `widget_type`  | Apenas timelines de collection. Defina como `grid` para exibir Posts em um layout de grade                                                                                                                                                                                                                                                                                                            | `grid`                                                                            |
| `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](/x-for-websites/supported-languages) suportado pelo X                                                                                                                                                                                                                                                                                                                           | `es`                                                                              |
| `related`      | Sugerir screen names adicionais do X relacionados ao widget como valores separados por vírgulas. O X pode sugerir essas contas para seguir depois que o usuário curtir um Post exibido. Você pode fornecer uma breve descrição de como a conta se relaciona ao Post com uma vírgula codificada em URL e texto após o screen name                                                                      | `x%3AX%20News,xapi%3AX%20API%20News`                                              |
| `theme`        | Quando definido como `dark`, a timeline é exibida com texto claro sobre fundo escuro                                                                                                                                                                                                                                                                                                                  | `dark`                                                                            |
| `border_color` | Definir a cor das bordas dos componentes do widget, incluindo a borda entre Posts, com um [valor de cor hexadecimal](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet)                                                                                                                                                                                                                            | `%23a80000`                                                                       |
| `chrome`       | Remove um componente de exibição da timeline com tokens separados por espaço:<br />• `noheader` — oculta o cabeçalho<br />• `nofooter` — oculta o rodapé, se visível<br />• `noborders` — remove todas as bordas: ao redor do widget, entre Posts e dentro de um Post<br />• `noscrollbar` — recorta e oculta a barra de rolagem da timeline, se visível<br />• `transparent` — remove a cor de fundo | `noheader%20nofooter`                                                             |
| `aria_polite`  | Definir um valor assertivo de [ARIA live region politeness](https://www.w3.org/TR/wai-aria/states_and_properties#aria-live) para Posts 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](https://support.x.com/articles/20169421) e [anúncios personalizados](https://support.x.com/articles/20170405)                                                                                                                                            | `true`                                                                            |

## Exemplos de requisição

```
GET https://publish.x.com/oembed?url=https://x.com/XDevelopers
twurl -H publish.x.com "/oembed?url=https://x.com/XDevelopers"
```

## Exemplo de resposta

```json title="Exemplo de resposta" lines wrap icon="https://mintcdn.com/x-preview/Vn2KEkZaPF9LiPi3/icons/xds/icon-brackets.svg?fit=max&auto=format&n=Vn2KEkZaPF9LiPi3&q=85&s=ed2428e77bab43e57800e1a590e982fa" theme={null}
{
  "url": "https://x.com/XDevelopers",
  "title": "",
  "html": "<a class=\"twitter-timeline\" href=\"https://x.com/XDevelopers\">Posts by XDevelopers</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": "X",
  "provider_url": "https://x.com",
  "version": "1.0"
}
```