{
"openapi": "3.0.1",
"info": {
"title": "Broken Link Checker – Website 404 & Dead Link Finder",
"description": "Crawl your website and find broken links (404s, dead domains, timeouts, invalid URLs), redirects and links that block bots, with every page and anchor text where each broken link appears.",
"version": "1.0",
"x-build-id": "ZCu41ZX1xdC10Loem"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/pinkish_armada~broken-link-checker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-pinkish_armada-broken-link-checker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/pinkish_armada~broken-link-checker/runs": {
"post": {
"operationId": "runs-sync-pinkish_armada-broken-link-checker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/pinkish_armada~broken-link-checker/run-sync": {
"post": {
"operationId": "run-sync-pinkish_armada-broken-link-checker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"startUrls"
],
"properties": {
"startUrls": {
"title": "Website(s) to check",
"type": "array",
"description": "Homepage or any page of the website you want to check. The crawler follows internal links from here. Please check sites you own or manage.",
"items": {
"type": "string"
}
},
"maxPages": {
"title": "Max pages to scan",
"minimum": 1,
"maximum": 20000,
"type": "integer",
"description": "Maximum number of internal HTML pages to download and scan for links. You are charged per scanned page, so this also caps cost. Internal links beyond this limit are still checked (lightweight request) but not scanned.",
"default": 100
},
"checkExternalLinks": {
"title": "Check external links",
"type": "boolean",
"description": "Also check links pointing to other websites (one lightweight request per unique link).",
"default": true
},
"checkResources": {
"title": "Check images, scripts & stylesheets",
"type": "boolean",
"description": "Also check img, script, stylesheet, icon, iframe and media URLs, not just <a href> links.",
"default": false
},
"onlyBrokenLinks": {
"title": "Save only broken links",
"type": "boolean",
"description": "When on, the dataset contains only broken links. Turn off to get every checked link with its verdict (ok, redirect, blocked, broken).",
"default": true
},
"reportBlockedAsBroken": {
"title": "Treat 401/403/429 as broken",
"type": "boolean",
"description": "Many sites (social networks, Cloudflare-protected sites) answer automated requests with 401/403/429/999 even though the link works in a browser. By default these are reported as blocked and not as broken.",
"default": false
},
"maxDepth": {
"title": "Max crawl depth",
"minimum": 0,
"type": "integer",
"description": "How many clicks away from the start URL to crawl. 0 = unlimited (bounded by Max pages).",
"default": 0
},
"includeSubdomains": {
"title": "Treat subdomains as internal",
"type": "boolean",
"description": "Crawl pages on subdomains (e.g. blog.example.com when starting at example.com).",
"default": false
},
"excludePatterns": {
"title": "Exclude URLs containing",
"type": "array",
"description": "Skip links matching any pattern. Plain text = substring, /regex/ = regular expression. Example: /wp-admin/, ?replytocom=.",
"default": [],
"items": {
"type": "string"
}
},
"respectRobotsTxt": {
"title": "Respect robots.txt",
"type": "boolean",
"description": "Do not crawl pages disallowed by the site's robots.txt. You can turn this off for your own site.",
"default": true
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Parallel page downloads (link checks use twice this). Keep it low to be gentle on small servers.",
"default": 5
},
"requestTimeoutSecs": {
"title": "Request timeout (seconds)",
"minimum": 5,
"maximum": 120,
"type": "integer",
"description": "Links that don't respond within this time (after retries) are reported as broken with error TIMEOUT.",
"default": 20
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}