{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker - Status Codes, Redirects & Sitemaps", "description": "Check thousands of links at once. Get the status code, redirect chain, final URL and speed of each link. Paste links, give a sitemap, or scan pages for their links. Follows robots.txt. $0.001 per link.", "version": "1.0", "x-build-id": "DdOGAzWG5JiAZPcJq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidybytetools~broken-link-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidybytetools-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/tidybytetools~broken-link-checker/runs": { "post": { "operationId": "runs-sync-tidybytetools-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/tidybytetools~broken-link-checker/run-sync": { "post": { "operationId": "run-sync-tidybytetools-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", "properties": { "urls": { "title": "Links to check", "type": "array", "description": "The links you want checked. You can also upload a text file with one link per line.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sitemapUrls": { "title": "Sitemap links", "type": "array", "description": "Links to sitemap.xml files. We check every page link in them (sitemap index files too).", "items": { "type": "string" } }, "pagesToScan": { "title": "Pages to scan for links", "type": "array", "description": "We open each page, find every link on it, and check them all. Each page costs $0.002 on top of the links.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "linkScope": { "title": "Which links on scanned pages", "enum": [ "all", "internal", "external" ], "type": "string", "description": "For 'Pages to scan' only.", "default": "all" }, "includeImages": { "title": "Also check images on scanned pages", "type": "boolean", "description": "Also check the image links (img src) on scanned pages.", "default": false }, "onlyProblems": { "title": "Only show problems", "type": "boolean", "description": "Only save broken links and links with a note (redirect, slow, not https). Every checked link is still charged. The full report is in report.csv.", "default": false }, "maxLinks": { "title": "Max links", "minimum": 1, "maximum": 100000, "type": "integer", "description": "We check at most this many links per run. Keeps costs in check.", "default": 5000 }, "respectRobotsTxt": { "title": "Follow robots.txt", "type": "boolean", "description": "Skip links a site's robots.txt asks bots not to open. Skipped links are free.", "default": true }, "perHostDelaySecs": { "title": "Wait between requests to the same site (seconds)", "type": "string", "description": "Be kind to small sites. 0.5 means at most 2 requests a second to one site. Other sites are checked at the same time.", "default": "0.5" }, "timeoutSecs": { "title": "Timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "How long to wait for each link before calling it 'timed out'.", "default": 15 }, "slowMs": { "title": "Slow after (milliseconds)", "minimum": 100, "type": "integer", "description": "Links that take longer than this get a 'slow' note.", "default": 2000 }, "useGet": { "title": "Use full GET requests", "type": "boolean", "description": "Off: we ask for headers only (HEAD), which is faster, and fall back to GET when a site refuses HEAD.", "default": false }, "checkDomains": { "title": "Flag odd-looking domains", "type": "boolean", "description": "Adds a warning for domains that look like a trick, like paypa1.com or a brand name on a risky ending. A hint, not proof.", "default": false }, "maxConcurrency": { "title": "Links checked at once", "minimum": 1, "maximum": 64, "type": "integer", "description": "How many links we check at the same time (across different sites).", "default": 16 } } }, "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 } } } } } } } } } }