Introduction
v1.0.0
WebPeek is a unified Web Intelligence API that provides structured data and insights from any public website.
What is WebPeek?
With a single API, you can:
- Extract metadata - Get Open Graph tags, Twitter Cards, Schema.org data, and more
- Audit SEO - Receive comprehensive SEO analysis with actionable recommendations
- Measure performance - Get Core Web Vitals and optimization tips
- Capture screenshots - Take high-quality snapshots with advanced options
Why WebPeek?
One API for Everything
Replace multiple services with a single integration
Always Compliant
Only accesses public pages, respects robots.txt
Developer-Friendly
RESTful JSON API with comprehensive documentation
Fast & Reliable
Intelligent caching and optimized infrastructure
Quick Example
Here's a simple example of extracting metadata from a URL:
curl "https://api.webpeek.dev/metadata?url=https://github.com" \
-H "X-API-Key: YOUR_API_KEY"Response:
{
"url": "https://github.com",
"final_url": "https://github.com",
"fetched_at": "2025-01-06T12:00:00.000Z",
"title": "GitHub: Let's build from here",
"description": "GitHub is where over 100 million developers...",
"language": "en",
"og": {
"title": "GitHub",
"image": "https://github.githubassets.com/images/og.png"
},
"twitter": {
"card": "summary_large_image",
"site": "github"
}
}Base URL
All API requests should be made to:
https://api.webpeek.dev