Skip to content
GET /v1/preview

Link preview / unfurl

Try it live

10 free calls per day — no sign-up, no API key. Goes through the oanor gateway.

Custom headers (optional)
api.oanor.com/url-api

It works. Grab an API key and use it in your project.

Get an API key

Code snippets

curl "https://api.oanor.com/url-api/v1/preview" \
  -H "x-oanor-key: oanor_test_..."
await fetch("https://api.oanor.com/url-api/v1/preview", {
  headers: { "x-oanor-key": "oanor_test_..." }
});
$ch = curl_init("https://api.oanor.com/url-api/v1/preview");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);
import requests
requests.get(
    "https://api.oanor.com/url-api/v1/preview",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "url": "https://github.com/",
        "type": "object",
        "image": "https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png",
        "title": "GitHub · Change is constant. GitHub keeps you ahead.",
        "favicon": "https://github.com/fluidicon.png",
        "final_url": "https://github.com/",
        "site_name": "GitHub",
        "description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity."
    },
    "meta": {
        "timestamp": "2026-05-30T01:37:03.784Z",
        "request_id": "f7e153ea-64fb-4c3d-b777-68214156ddb7"
    },
    "status": "ok",
    "message": "Preview retrieved successfully",
    "success": true
}