# Sitemap URL Extractor — recursive, filters, .gz (`x402opklaar/sitemap-url-extractor`) Actor

Extract every URL from any sitemap: recursive sitemap-index expansion, gzipped sitemaps, robots.txt auto-discovery, include/exclude filters, lastmod output. Feed the URL list to any crawler or audit. Pay per sitemap file processed.

- **URL**: https://apify.com/x402opklaar/sitemap-url-extractor.md
- **Developed by:** [Opklaar](https://apify.com/x402opklaar) (community)
- **Categories:** SEO tools, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$1.00 / 1,000 sitemap file fetcheds

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/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Sitemap URL Extractor — recursive, filters, .gz

Turn any sitemap into a flat, deduplicated URL list — with `lastmod`, `changefreq`, and `priority` — ready to feed into a crawler, SEO audit, content inventory, or link checker.

- **Sitemap indexes** expanded recursively (nested sitemaps followed automatically, up to 500 files)
- **Gzipped** sitemaps (`.xml.gz`) handled transparently
- **Auto-discovery**: pass just `https://example.com` and the sitemap is found via `robots.txt` and common locations
- **Include/exclude filters**: plain substrings or `/regex/` — extract only `/blog/`, skip `/tag/`, etc.
- **Deduplicated** output with a `maxUrls` cap for very large sites

### Input

```json
{
    "sitemapUrls": ["https://example.com"],
    "includePatterns": ["/blog/"],
    "excludePatterns": ["/tag/", "/page/"],
    "maxUrls": 100000
}
```

### Output (one dataset item per URL)

```json
{
    "url": "https://example.com/blog/hello-world",
    "lastmod": "2026-07-14",
    "changefreq": "weekly",
    "priority": "0.8",
    "sitemap": "https://example.com/sitemap-posts.xml"
}
```

Export as JSON, CSV, or Excel straight from the dataset tab, or fetch via API.

### Pricing

Pay per event — `sitemap-fetched`, charged once per sitemap file successfully fetched and parsed (an index file and each nested sitemap count once each). A sitemap that fails to download or parse is **free**. There are no per-URL charges: a 50,000-URL sitemap in one file costs one event.

### Common uses

- Seed list for any crawler or scraper (pairs well with an article extractor for full-content pipelines)
- SEO: find URLs missing from a sitemap, compare `lastmod` freshness, inventory a competitor's content structure
- Migration QA: diff URL lists before/after a relaunch

### Works with AI agents

Exposed through Apify's MCP server — an AI agent can ask *"list every blog URL on example.com"* and get structured JSON back in seconds.

### FAQ

**What if the site has no sitemap?** Auto-discovery checks `robots.txt` plus common paths (`/sitemap.xml`, `/wp-sitemap.xml`, …). If nothing is found, the run tells you — and costs nothing.

**Does it respect huge sitemap indexes?** Yes — nested sitemaps are queued breadth-first with a 500-file safety cap and your `maxUrls` limit.

# Actor input Schema

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

Sitemap URLs (sitemap.xml, sitemap index, .gz) — or just a site root like https://example.com and the sitemap is auto-discovered via robots.txt and common locations.

## `includePatterns` (type: `array`):

Optional substrings or /regex/ — keep only URLs matching at least one (e.g. "/blog/").

## `excludePatterns` (type: `array`):

Optional substrings or /regex/ — drop URLs matching any (e.g. "/tag/").

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

Stop after this many URLs total (0 = unlimited).

## Actor input object example

```json
{
  "sitemapUrls": [
    "https://www.sitemaps.org/sitemap.xml"
  ],
  "maxUrls": 100000
}
```

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

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

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

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,x402opklaar/sitemap-url-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/zFiQUx3aEQpht2hbj/builds/RU1vj50epKID9dVK6/openapi.json