API Documentation

The URLPreview API allows you to retrieve clean, structured metadata for any public URL, including title, description, images, and favicon.

Base Endpoint

GET https://app.urlpreview.com/api/v1/preview

Authentication

All requests must include your API key as a query parameter:

?url=https://example.com&apiKey=YOUR_API_KEY

You can get an API key in your dashboard after signing up.

Query Parameters

• url (required): The full URL you want to preview.
• apiKey (required): Your unique API key.

Example Request

curl "https://app.urlpreview.com/api/v1/preview?url=https://example.com&apiKey=YOUR_API_KEY"

Example Response

{
  "url": "https://example.com",
  "title": "Example Domain",
  "description": "This domain is for use in illustrative examples in documents.",
  "image": "https://example.com/og-image.jpg"
}

Usage Limits

Your plan determines your monthly quota:

• Free plan: 10,000 requests/month (limited to 30 per hour)
• Paid plans: No hourly throttling. Use your monthly quota any way you prefer.

Error Handling

On error, the API responds with a JSON object containing an error field.

{
  "error": "Invalid or unreachable URL"
}

Best Practices

• Always validate URLs before requesting metadata.
• Cache results whenever possible to reduce redundant calls.
• Respect target site robots.txt policies and terms of use.

Support

For help, contact us at support@urlpreview.com.