# Sitemap Extractor — XML Sitemap to URL List (Index & Gzip) (`scarlet_harrier/sitemap-extractor`) Actor

Give it a domain; get every URL in its sitemaps with lastmod, changefreq and priority. Finds sitemaps via robots.txt and common paths, follows sitemap indexes, handles .xml.gz. Fast, cheap, no browser.

- **URL**: https://apify.com/scarlet_harrier/sitemap-extractor.md
- **Developed by:** [Upton & Partners](https://apify.com/scarlet_harrier) (community)
- **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 extracteds

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 Extractor — XML Sitemap to URL List (Index & Gzip)

Give it a website. Get back every URL listed in its sitemaps — with `lastmod`, `changefreq` and `priority` — as a clean table you can export to CSV, JSON or Excel, or pull via API.

### What it does

- **Finds sitemaps automatically** from `robots.txt`, falling back to `/sitemap.xml`, `/sitemap_index.xml` and `/sitemap.xml.gz`
- **Follows sitemap indexes** to any depth
- **Reads gzipped sitemaps** (`.xml.gz`)
- **Filters** to URLs containing a substring, e.g. `/blog/`
- **No browser, no proxies** — plain HTTP, so it's fast and cheap

### Use cases

- SEO audits and content inventories
- Seeding a crawler or a RAG pipeline with a site's full URL list
- Monitoring when pages were last modified
- Migration checks: compare URL sets before and after a relaunch

### Input

| Field | Description |
|---|---|
| `domains` | Websites, e.g. `example.com`. Sitemaps are discovered automatically. |
| `sitemapUrls` | Optional direct sitemap URLs. |
| `maxUrls` | Cap per website. Default 50,000. |
| `includeFilter` | Optional substring filter. |

```json
{ "domains": ["example.com"], "maxUrls": 10000, "includeFilter": "/blog/" }
```

### Output

```json
{
  "url": "https://example.com/blog/post-1",
  "lastmod": "2026-09-14",
  "changefreq": "weekly",
  "priority": 0.8,
  "sitemap": "https://example.com/sitemap-blog.xml",
  "domain": "https://example.com"
}
```

### Pricing

Pay per URL extracted. You only pay for results.

### Notes

- Reads only public sitemap files that sites publish for crawlers. It does not crawl pages or collect personal data.
- If a site publishes no sitemap, the run finishes with zero results and you pay nothing.
- This Actor was built and is maintained with AI assistance, with human review. Issues are answered within a few days.

# Actor input Schema

## `domains` (type: `array`):

Domains or URLs, e.g. example.com or https://example.com. Sitemaps are discovered automatically.

## `sitemapUrls` (type: `array`):

Direct sitemap URLs, if you already know them.

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

Stop after this many URLs per website.

## `includeFilter` (type: `string`):

Optional substring filter, e.g. /blog/

## Actor input object example

```json
{
  "domains": [
    "apify.com"
  ],
  "maxUrls": 200
}
```

# 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 = {
    "domains": [
        "apify.com"
    ],
    "maxUrls": 200
};

// Run the Actor and wait for it to finish
const run = await client.actor("scarlet_harrier/sitemap-extractor").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 = {
    "domains": ["apify.com"],
    "maxUrls": 200,
}

# Run the Actor and wait for it to finish
run = client.actor("scarlet_harrier/sitemap-extractor").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 '{
  "domains": [
    "apify.com"
  ],
  "maxUrls": 200
}' |
apify call scarlet_harrier/sitemap-extractor --silent --output-dataset

```

## MCP server setup

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

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/8oZM5SJp8HmMohgVq/builds/QNAu6ItjrVuZ3wy7Q/openapi.json