---
title: "Resolve OpenGraph metadata for a URL"
method: GET
path: "/v1/unfurl"
tags: ["unfurl"]
---

# Resolve OpenGraph metadata for a URL

`GET /v1/unfurl`

## Query parameters

- `url` string, uri, required

## Response `200`

Successful response

- LinkPreview
  - `url` string, required
  - `title` string, nullable, required
  - `description` string, nullable, required
  - `image` string, nullable, required
  - `imageWidth` integer, nullable, required
  - `imageHeight` integer, nullable, required
  - `isPlayable` boolean
  - `siteName` string, nullable, required
  - `favicon` string, nullable, required

## Other responses

- `400` — Invalid input data
- `404` — Resource not found
- `500` — Internal server error

## Changes

- **2026-08-21** `9651975196e7` — 1 info
  - added the optional property `isPlayable` to the response with the `200` status
- **2026-08-19** `7f25911f3015` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/legend/apis/legend-api/changes/v1/unfurl/get.md)

---

[API](https://skmtc.dev/legend/apis/legend-api.md) · [All operations](https://skmtc.dev/legend/apis/legend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/legend/apis/legend-api/revisions/1edcd08d9f89?raw)