# Sitemap Auditor (`axelhu/sitemap-auditor`) Actor

Discover XML sitemap indexes and export a bounded, deduplicated URL inventory with alternate-language links.

- **URL**: https://apify.com/axelhu/sitemap-auditor.md
- **Developed by:** [Axel Hu](https://apify.com/axelhu) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.08 / 1,000 unique sitemap urls

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 Auditor

Export a deduplicated URL inventory from public XML sitemaps and nested sitemap
indexes. Website inputs discover Sitemap directives in robots.txt and fall back
to /sitemap.xml. Output includes loc, source sitemap, lastmod/changefreq/priority
and optional alternate-language links. It does not crawl or verify each listed page.

### Example

```json
{"startUrls":["https://www.sitemaps.org/sitemap.xml"],"maxSitemaps":20,"maxEntries":1000,"includeAlternates":true}
```

Results go to the default Dataset and diagnostics/limits to SUMMARY.
An empty result with fetch/parsing failures fails the run; a valid empty sitemap
may succeed with no output. Partial runs retain their successfully found entries.

### Pricing

$0.00005 per run start plus $0.00008 per unique URL emitted ($0.08/1,000).
A run emitting 20 URLs costs $0.00165. Failed fetches and duplicates have no URL
charge; the start charge still applies. Respecting the user's charge limit can
truncate the inventory.

### Limits and safety

At most 10 input URLs, 100 sitemap documents, 10,000 output entries, 150 HTTP
attempts, 20 MB transferred and 40 MB decoded per run. Each sitemap is limited to
5 MB and each robots.txt to 1 MB; fetch timeout is 3–60 seconds. gzip, Brotli and
deflate HTTP encodings and bounded gzip sitemap files are supported. XML DTD and
entity declarations are rejected. Limits may yield partial inventories.
Every redirect is revalidated (up to 5); connections use validated, pinned public
IP addresses. Private/reserved/transition addresses, URL credentials, and ports
other than HTTP(S) 80/443 are rejected. No browser, login, cookies or paid external
API. Query values in output URLs are redacted, so query-dependent inventories
require another tool; no raw secret-bearing URL is logged.

### Support

Open an Issue on this Actor's Apify page with a run ID and non-sensitive sample.
Do not post credentials or private URLs.

# Actor input Schema

## `startUrls` (type: `array`):

Enter website roots or direct XML sitemap URLs.

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

Safety limit for recursively followed sitemap files.

## `maxEntries` (type: `integer`):

Stop after this many URL entries have been emitted.

## `timeoutSecs` (type: `integer`):

Per-request timeout in seconds.

## `includeAlternates` (type: `boolean`):

Extract xhtml:link hreflang alternates when present.

## Actor input object example

```json
{
  "startUrls": [
    "https://www.sitemaps.org/sitemap.xml"
  ],
  "maxSitemaps": 20,
  "maxEntries": 1000,
  "timeoutSecs": 20,
  "includeAlternates": true
}
```

# Actor output Schema

## `dataset` (type: `string`):

No description

## `summary` (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 = {
    "startUrls": [
        "https://www.sitemaps.org/sitemap.xml"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("axelhu/sitemap-auditor").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 = { "startUrls": ["https://www.sitemaps.org/sitemap.xml"] }

# Run the Actor and wait for it to finish
run = client.actor("axelhu/sitemap-auditor").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 '{
  "startUrls": [
    "https://www.sitemaps.org/sitemap.xml"
  ]
}' |
apify call axelhu/sitemap-auditor --silent --output-dataset

```

## MCP server setup

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

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/hjROtvfcHUKj5J6SN/builds/JITTY2jBnFq5uFmzb/openapi.json