---
title: "Get oEmbed data for the given URL"
method: GET
path: "/oembed/"
tags: ["oEmbed"]
---

# Get oEmbed data for the given URL

`GET /oembed/`

Get oEmbed data for the given URL. This is the oEmbed 1.0 consumer endpoint.

## Query parameters

- `url` string, required

## Response `200`

OK

- object
  - `version` string — oEmbed version (always '1.0')
  - `type` string — oEmbed type (e.g. 'rich')
  - `provider_name` string
  - `provider_url` string
  - `author_name` string
  - `author_url` string
  - `html` string — HTML embed code
  - `referrer` string
  - `cache_age` integer — Recommended cache lifetime in seconds

## Other responses

- `default` — Error

## Changes

- **2026-03-18** `e271d0e41f6d` — 3 info
  - api operation id `get_oembed_` removed and replaced with `getOembed`
  - added the new optional `header` request parameter `XF-Api-User` to all path's operations
  - added the new optional `query` request parameter `api_bypass_permissions` to all path's operations
- **2026-03-06** `61b60b0c0d52` — 1 breaking, 3 info
  - added the new required `query` request parameter `url`
  - api tag `oEmbed` added
  - api tag `oembed` removed
  - added the media type `application/json` for the response with the status `200`
- **2026-02-03** `fc0a40f3b859` — 1 breaking, 5 warning, 3 info
  - removed the media type `application/json` for the response with the status `200`
  - the optional response header `XF-Latest-Api-Version` removed for the status `200`
  - the optional response header `XF-Request-User` removed for the status `200`
  - the optional response header `XF-Request-User-Extras` removed for the status `200`
  - …5 more

[Change history](https://skmtc.dev/xenforo-ltd/apis/xenforo-api/changes/oembed/get.md)

---

[API](https://skmtc.dev/xenforo-ltd/apis/xenforo-api.md) · [All operations](https://skmtc.dev/xenforo-ltd/apis/xenforo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xenforo-ltd/xenforo-api/revisions/b15eba33657a/schema)