Skip to main content
POST
/
brokenlink
Check if a webpage contains broken links
curl --request POST \
  --url https://api.geekflare.com/brokenlink \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com",
  "followRedirect": false,
  "proxyCountry": "us"
}
'
{
  "timestamp": 1776233511285,
  "apiStatus": "success",
  "apiCode": 200,
  "message": "No broken links found.",
  "meta": {
    "url": "example.com",
    "proxyCountry": "United States",
    "followRedirect": true,
    "redirectedURL": "https://example.com/",
    "test": {
      "id": "wf0b7yrn05br8xtwple7ngj7hhxzvl2e"
    }
  },
  "summary": {
    "total": 5,
    "successful": 2,
    "redirects": 2,
    "broken": 1,
    "serverError": 0
  },
  "data": [
    {
      "link": "https://example.com/",
      "status": 200
    },
    {
      "link": "https://example.com/articles",
      "status": 200
    }
  ]
}

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"

​
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"

Response

Successfully checked for broken links

​
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

​
message
string
required

Human-readable message about the broken link scan result

Example:

"No broken links found."

​
meta
object
required

Metadata about the broken link request

Example:
{
  "url": "example.com",
  "proxyCountry": "United States",
  "followRedirect": true,
  "redirectedURL": "https://example.com/",
  "test": { "id": "wf0b7yrn05br8xtwple7ngj7hhxzvl2e" }
}
​
summary
object
required

Summary of link check results categorized by status

Example:
{
  "total": 5,
  "successful": 2,
  "redirects": 2,
  "broken": 1,
  "serverError": 0
}
​
data
string[]
required

List of links found on the page and their HTTP status

Example:
[
  {
    "link": "https://example.com/",
    "status": 200
  },
  {
    "link": "https://example.com/articles",
    "status": 200
  }
]