API Reference

Complete reference documentation for the Lighthouse Metrics API.

Authentication

To authenticate with the API, you'll need to include your API key in the Authorization header of each request.

Authorization: Bearer YOUR_API_KEY

Rate Limits

API requests are limited to 100 requests per minute per API key. Rate limit information is included in the response headers:

  • X-RateLimit-Limit: Maximum number of requests allowed per window
  • X-RateLimit-Remaining: Number of requests remaining in the current window
  • X-RateLimit-Reset: Time when the rate limit will reset

Endpoints

The Lighthouse Metrics API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://api.lighthouse-metrics.com/v1

Issues

Common API issues and troubleshooting steps:

Authentication Errors

If you receive a 401 Unauthorized response, check that you're using the correct API key and that it's properly formatted in the Authorization header.

Rate Limit Exceeded

If you're receiving a 429 Too Many Requests error, you've exceeded your rate limit. Wait until your rate limit window resets before making additional requests.