Pro Feature

API Documentation

Integrate Broken Link Scan into your workflow. Scan sites, retrieve results, and automate monitoring — all via a simple REST API.

Base URL

https://brokenlinkscan.com/api/v1

All API requests require an API key sent via the X-Api-Key header. You can generate your API key from the dashboard.

curl -H "X-Api-Key: your_key" \
     https://brokenlinkscan.com/api/v1/sites

Authenticated users are allowed 300 requests per minute. If you exceed this limit, the API returns a 429 Too Many Requests response.

GET /api/v1/sites

List all monitored sites for the authenticated user.

POST /api/v1/sites

Add a new site to monitor.

Request Body

{ "url": "https://example.com", "name": "My Site" }

DELETE /api/v1/sites/:id

Remove a monitored site by ID.

POST /api/v1/sites/:id/scan

Trigger an on-demand scan for a site.

GET /api/v1/scans

List all scans.

Query Parameters

page (int), limit (int, default 20)

GET /api/v1/scans/:token

Get the status of a specific scan.

GET /api/v1/scans/:token/results

Get detailed scan results.

Query Parameters

status, category, search, page, limit

GET /api/v1/scans/:token/export.json

Export scan results as JSON.

GET /api/v1/scans/:token/export.csv

Export scan results as CSV.

POST /api/v1/scans/bulk

Bulk-check a list of URLs in a single request.

Request Body

{ "urls": ["https://a.com", "https://b.com"] }

All responses are JSON. Successful requests return the data directly. Errors include a message field.

Success (200)

{
  "data": [...],
  "meta": { "page": 1, "limit": 20, "total": 42 }
}

Error (4xx/5xx)

{
  "error": { "code": 401, "message": "Invalid API key" }
}

The REST API is available on the Pro plan. Upgrade today and start automating your broken link monitoring.