Skip to main content
POST
/
lighthouse
Run Lighthouse audit on a website
curl --request POST \
  --url https://api.geekflare.com/lighthouse \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com",
  "device": "desktop",
  "followRedirect": false,
  "proxyCountry": "us",
  "parameters": [
    "--only-categories=seo"
  ]
}
'
{
  "timestamp": 1776233511285,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "device": "desktop",
    "followRedirect": true,
    "redirectedURL": "https://example.com/",
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    },
    "proxyCountry": "<string>"
  },
  "data": "https://example.com/report.html"
}

Documentation Index

Fetch the complete documentation index at: https://docs.geekflare.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
​
url
string
required

Target URL

Example:

"https://example.com"

​
device
enum<string>
default:desktop

Device type to emulate. Defaults to desktop.

Available options:
desktop,
mobile
Example:

"desktop"

​
followRedirect
boolean
default:false

Whether to follow redirects when checking site status

Example:

false

​
proxyCountry
string

Proxy country code to route the request

Example:

"us"

​
parameters
string[]

Extra Lighthouse CLI parameters

Example:
["--only-categories=seo"]

Response

Successfully ran Lighthouse audit

​
timestamp
number
required

Timestamp of the request in milliseconds

Example:

1776233511285

​
apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

​
apiCode
number
required

API status code

Example:

200

​
meta
object
required

Metadata about the request

​
data
string
required

URL to the Lighthouse report

Example:

"https://example.com/report.html"