On-Page & Lighthouse
Lighthouse Audit
Run a Google Lighthouse audit — performance, accessibility, SEO, and Core Web Vitals.
POST
$0.05/call/v1/seo/onpage/lighthouseUsage
const res = await fetch('https://api.yepapi.com/v1/seo/onpage/lighthouse', {
method: 'POST',
headers: {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"url": "https://vercel.com"
}),
});
const { data } = await res.json();
console.log(data);curl -X POST https://api.yepapi.com/v1/seo/onpage/lighthouse \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://vercel.com"}'Request Body
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
url | string | Yes | Full URL to audit | — |
Response
{
"ok": true,
"data": {
"accessibilityScore": 0.96,
"bestPracticesScore": 0.96,
"cumulativeLayoutShift": 0.0,
"firstContentfulPaint": 379.582,
"largestContentfulPaint": 739.582,
"performanceScore": 1.0,
"seoScore": 1.0,
"speedIndex": 517.72,
"totalBlockingTime": 0.0,
"url": ""
}
}Response Fields
| Field | Type | Description |
|---|---|---|
ok | boolean | Whether the request succeeded |
data.performanceScore | number | Lighthouse performance score (0-1) |
data.accessibilityScore | number | Lighthouse accessibility score (0-1) |
data.bestPracticesScore | number | Lighthouse best practices score (0-1) |
data.seoScore | number | Lighthouse SEO score (0-1) |
data.firstContentfulPaint | number | First Contentful Paint in milliseconds (FCP) |
data.largestContentfulPaint | number | Largest Contentful Paint in milliseconds (LCP) |
data.cumulativeLayoutShift | number | Cumulative Layout Shift score (CLS) |
data.speedIndex | number | Speed Index in milliseconds |
data.totalBlockingTime | number | Total Blocking Time in milliseconds (TBT) |
data.url | string | The URL that was audited |
Under the Hood
Full Lighthouse audit. Scores and Core Web Vitals in one call.