# Sitemap Link Health Checker (`catblik/sitemap-link-checker`) Actor

Extract URLs from public XML sitemaps and check a bounded sample for HTTP errors and redirects while respecting robots.txt.

- **URL**: https://apify.com/catblik/sitemap-link-checker.md
- **Developed by:** [asaf meizner](https://apify.com/catblik) (community)
- **Categories:** SEO tools, Developer tools
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 url checkeds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Sitemap Link Health Checker

Check HTTP health for URLs listed in a public XML sitemap. Use it for sites you own or have permission to audit. It respects robots.txt and uses sequential requests with at least one second between checks, plus any declared crawl delay.

### Input

```json
{"sitemapUrl":"https://docs.python.org/sitemap.xml","maxUrls":20,"maxSitemaps":5}
```

Sitemap indexes and page URLs are followed within the starting origin only. Defaults: 20 page checks and 5 sitemap documents; hard limits: 200 pages and 20 sitemap documents. Redirects are limited to nine requests and checked against robots.txt at each destination. Cross-origin redirects are skipped. Responses are limited to 3 MB decoded; XML entities are rejected. Temporary HTTP failures receive up to two retries. No recursive HTML crawling, proxies, logins or browser automation.

### Example output

Illustrative row showing the output shape; timing varies by run:

```json
{
  "url": "https://docs.python.org/3.13/",
  "sitemapUrl": "https://docs.python.org/sitemap.xml",
  "finalUrl": "https://docs.python.org/3.13/",
  "status": 200,
  "redirects": 0,
  "responseMs": 1120,
  "healthy": true,
  "type": "url-check"
}
```

To find broken sitemap links, filter the dataset for `type` equal to `url-check` and `healthy` equal to `false`. Keep `url-error` rows separately: they indicate a check could not finish, rather than a confirmed HTTP error. Export the dataset as JSON or CSV for a spreadsheet or scheduled monitoring workflow.

### Output and pricing

Each `url-check` row contains `url`, `sitemapUrl`, `finalUrl`, `status`, `redirects`, `responseMs`, and `healthy` (HTTP 200–399). Timing includes rate-limit waits and retries. Sitemap parsing failures produce `sitemap-error`; blocked or unreachable pages produce `url-error`. HTTP health does not establish content quality or indexability. Large pages exceeding the response limit cannot be checked.

Price: $0.001 per completed `url-check` ($1 per 1,000), including responses such as HTTP 404. Network failures, oversized responses and robots-denied URLs are not charged.

### Verification and limits

On October 18, 2026, the actor ran end to end locally against https://docs.python.org/sitemap.xml and checked the Python 3.11, 3.12 and 3.13 documentation roots: all returned HTTP 200. Seven parser/HTTP safety tests passed. The public robots file advertises this sitemap and permits these paths; documentation licensing is at https://docs.python.org/3/license.html. Users must verify authorization and applicable site terms. Robots permission alone does not establish authorization. This is a speculative portfolio experiment with unproven Store demand.

# Actor input Schema

## `sitemapUrl` (type: `string`):

Public XML sitemap or sitemap index URL for a site you are authorized to audit. Only same-origin URLs are followed.

## `maxUrls` (type: `integer`):

Maximum number of sitemap page URLs to check in this run (1–200).

## `maxSitemaps` (type: `integer`):

Maximum number of sitemap XML documents to fetch, including the starting document (1–20).

## Actor input object example

```json
{
  "sitemapUrl": "https://docs.python.org/sitemap.xml",
  "maxUrls": 20,
  "maxSitemaps": 5
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "sitemapUrl": "https://docs.python.org/sitemap.xml"
};

// Run the Actor and wait for it to finish
const run = await client.actor("catblik/sitemap-link-checker").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "sitemapUrl": "https://docs.python.org/sitemap.xml" }

# Run the Actor and wait for it to finish
run = client.actor("catblik/sitemap-link-checker").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "sitemapUrl": "https://docs.python.org/sitemap.xml"
}' |
apify call catblik/sitemap-link-checker --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,catblik/sitemap-link-checker"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/eR0pfll8L6fzhfwAa/builds/StBH6W0tjW1V21BpR/openapi.json
