Skip to content
Gridlode
Docs · Reference

Broken Link Checker

GET /v1/url/broken-links1 credit / pagecache 60 min

Crawl up to `limit` pages of a website and check every link found on them, internal and external (and optionally images): broken links (404, 410, 5xx, DNS and connection errors, timeouts) with the HTTP status or error, every page they appear on and their anchor text; internal redirect chains; links that refused the check (401/403/429) listed separately so they are not mistaken for broken; and a summary. HEAD first with a GET fallback, de-duplicated, concurrency-limited, short timeouts. Respects robots.txt and Crawl-delay by default. Charged per page crawled (link checks are free); failed crawls are not charged.

Query parameters

url
string · required
Start URL: a site root or any page. Pages on the same site (same registrable domain) are crawled; links on them are checked.
limit
integer
Maximum number of pages to crawl for links. Charged 1 credit per page crawled; link checks are free.
Default: 10
max_depth
integer
How many links deep to crawl from the start page.
Default: 3
check_external
boolean
Also check links that point to other websites.
Default: true
check_images
boolean
Also check image sources (<img src>).
Default: false
respect_robots
boolean
Don't crawl or check URLs on this site that robots.txt disallows, and honour its Crawl-delay.
Default: true
max_age
integer
Accept a cached answer up to this many seconds old, billed at 50%.

Response data fields

    Example

    curl "https://api.gridlode.com/v1/url/broken-links?url=https%3A%2F%2Fquotes.toscrape.com%2F&limit=2&max_depth=1" \
  -H "Authorization: Bearer $GRIDLODE_KEY"

    Try it without code on the Broken Link Checker API page.