# Sitemap URL Extractor - every page URL with lastmod (`forge_creations/sitemap-url-extractor`) Actor

Extract every page URL from any website's XML sitemaps. Reads robots.txt, follows sitemap indexes and .gz files, and returns each URL with lastmod, changefreq, priority and source sitemap. Many sites per run. Fast HTTP only, no browser. Export to CSV, JSON or Excel.

- **URL**: https://apify.com/forge_creations/sitemap-url-extractor.md
- **Developed by:** [Forge Creations](https://apify.com/forge_creations) (community)
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.25 / 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 URL Extractor: every page URL with lastmod

Give it a list of websites. For each one it reads the sitemaps the site publishes for crawlers and returns every page URL listed, with:

- `loc` (the page URL), `lastmod`, `changefreq`, `priority`, when present
- `sitemap`: the sitemap file it came from, and `site`

It finds sitemaps from robots.txt `Sitemap:` lines, then common locations (`/sitemap.xml`, `/sitemap_index.xml`, `/wp-sitemap.xml`, ...). It follows sitemap indexes up to 5 levels deep and reads `.gz` sitemaps.

### Pricing

**$0.00025 per URL returned** ($0.25 per 1,000), plus Apify's standard start fee of $0.00005 per run. Sitemap files read, filtered-out URLs and the per-website summary are not charged. Set a maximum charge in run options to cap spending; the run stops cleanly at that limit.

### Input

| Field | Default | Notes |
|---|---|---|
| websites | required | Domains or URLs |
| maxUrlsPerWebsite | 10000 | Stops each site at this many URLs (summary marks it truncated) |
| includeRegex / excludeRegex | none | Keep or skip URLs by pattern |
| maxIndexDepth | 3 | Nested sitemap-index levels |

### Output

Dataset: one row per URL. Key-value store `SUMMARY`: one row per website with status (`ok`, `no_sitemap`, `invalid_input`), sitemaps read, URLs found/returned, truncation.

### Limits

It returns only what sites list in their sitemaps; it does not crawl links. Sites without a sitemap return `no_sitemap` and cost nothing beyond the start fee.

### Support

Open an issue on the Issues tab with the website and run ID.

# Actor input Schema

## `websites` (type: `array`):

Domains or URLs (e.g. example.com). The site's robots.txt and common sitemap locations are checked.

## `maxUrlsPerWebsite` (type: `integer`):

Stop collecting a site's URLs after this many; the summary marks the site as truncated.

## `includeRegex` (type: `string`):

Example: /blog/

## `excludeRegex` (type: `string`):

Example: ?|/tag/

## `maxIndexDepth` (type: `integer`):

How many levels of nested sitemap indexes to follow.

## `maxConcurrency` (type: `integer`):

How many websites are processed in parallel.

## Actor input object example

```json
{
  "websites": [
    "docs.apify.com"
  ],
  "maxUrlsPerWebsite": 200,
  "maxIndexDepth": 3,
  "maxConcurrency": 5
}
```

# Actor output Schema

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

Every page URL found in the sitemaps, with lastmod, changefreq, priority and the sitemap it came from.

## `summary` (type: `string`):

Sitemaps read, URLs found and returned, and whether each site was truncated. Not charged.

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

// Run the Actor and wait for it to finish
const run = await client.actor("forge_creations/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 = {
    "websites": ["docs.apify.com"],
    "maxUrlsPerWebsite": 200,
}

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

```

## MCP server setup

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