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"
}
'import requests
url = "https://api.geekflare.com/brokenlink"
payload = {
"url": "https://example.com",
"followRedirect": False,
"proxyCountry": "us"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://example.com', followRedirect: false, proxyCountry: 'us'})
};
fetch('https://api.geekflare.com/brokenlink', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.geekflare.com/brokenlink",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://example.com',
'followRedirect' => false,
'proxyCountry' => 'us'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.geekflare.com/brokenlink"
payload := strings.NewReader("{\n \"url\": \"https://example.com\",\n \"followRedirect\": false,\n \"proxyCountry\": \"us\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.geekflare.com/brokenlink")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com\",\n \"followRedirect\": false,\n \"proxyCountry\": \"us\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.geekflare.com/brokenlink")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com\",\n \"followRedirect\": false,\n \"proxyCountry\": \"us\"\n}"
response = http.request(request)
puts response.read_body{
"timestamp": 1783943217189,
"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
}
]
}{
"timestamp": 1700000000000,
"apiStatus": "failure",
"apiCode": 400,
"message": "INVALID_URL",
"details": "The URL must be a valid HTTP or HTTPS URL."
}{
"timestamp": 1700000000000,
"apiStatus": "failure",
"apiCode": 422,
"message": "UNABLE_TO_CONNECT",
"details": "The destination server could not be resolved, refused the connection, timed out, or is redirecting indefinitely."
}Endpoint
Broken Link Checker
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"
}
'import requests
url = "https://api.geekflare.com/brokenlink"
payload = {
"url": "https://example.com",
"followRedirect": False,
"proxyCountry": "us"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://example.com', followRedirect: false, proxyCountry: 'us'})
};
fetch('https://api.geekflare.com/brokenlink', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.geekflare.com/brokenlink",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://example.com',
'followRedirect' => false,
'proxyCountry' => 'us'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.geekflare.com/brokenlink"
payload := strings.NewReader("{\n \"url\": \"https://example.com\",\n \"followRedirect\": false,\n \"proxyCountry\": \"us\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.geekflare.com/brokenlink")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com\",\n \"followRedirect\": false,\n \"proxyCountry\": \"us\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.geekflare.com/brokenlink")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com\",\n \"followRedirect\": false,\n \"proxyCountry\": \"us\"\n}"
response = http.request(request)
puts response.read_body{
"timestamp": 1783943217189,
"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
}
]
}{
"timestamp": 1700000000000,
"apiStatus": "failure",
"apiCode": 400,
"message": "INVALID_URL",
"details": "The URL must be a valid HTTP or HTTPS URL."
}{
"timestamp": 1700000000000,
"apiStatus": "failure",
"apiCode": 422,
"message": "UNABLE_TO_CONNECT",
"details": "The destination server could not be resolved, refused the connection, timed out, or is redirecting indefinitely."
}Authorizations
API Key required for all endpoints
Body
application/json
Response
Successfully checked for broken links
Timestamp of the request in milliseconds
Example:
1783943217189
API status message
Available options:
success, failure Example:
"success"
API status code
Example:
200
Human-readable message about the broken link scan result
Example:
"No broken links found."
Metadata about the broken link request
Show child attributes
Show child attributes
Example:
{
"url": "example.com",
"proxyCountry": "United States",
"followRedirect": true,
"redirectedURL": "https://example.com/",
"test": { "id": "wf0b7yrn05br8xtwple7ngj7hhxzvl2e" }
}
Summary of link check results categorized by status
Show child attributes
Show child attributes
Example:
{
"total": 5,
"successful": 2,
"redirects": 2,
"broken": 1,
"serverError": 0
}
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
}
]
⌘I