Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132176113.0 KB
brokenlink

Check if a webpage contains broken links

post/brokenlink

Request body

urlstring required

Target URL

proxyCountrystring

Proxy country code to route the request

followRedirectboolean

Whether to follow redirects when checking site status

Example request

{
  "url": "https://example.com",
  "proxyCountry": "us"
}

Response

Successfully checked for broken links

timestampnumber required

Timestamp of the request in milliseconds

apiStatus'success' | 'failure' required

API status message

apiCodenumber required

API status code

messagestring required

Human-readable message about the broken link scan result

datastring[] required

List of links found on the page and their HTTP status

Example response

{
  "timestamp": 1763372588297,
  "apiStatus": "success",
  "apiCode": 200,
  "message": "No broken links found.",
  "meta": {
    "url": "example.com",
    "proxyCountry": "United States",
    "followRedirect": true,
    "redirectedURL": "https://example.com/",
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    }
  },
  "data": [
    {
      "link": "https://example.com/",
      "status": 200
    },
    {
      "link": "https://example.com/articles",
      "status": 200
    }
  ]
}