# Sitemap URL Extractor (`alaudinburki/sitemap-url-extractor`) Actor

Extract every URL from a site's sitemaps — follows sitemap-index files, reads robots.txt to discover them, decompresses .gz sitemaps, and returns lastmod/changefreq/priority. Feeds any other scraper. Pure logic.

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

## Pricing

from $0.50 / 1,000 results

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?

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

Extract every URL from a site's sitemaps — follows sitemap-index files, reads robots.txt to discover them, decompresses .gz sitemaps, and returns lastmod/changefreq/priority. Feeds any other scraper. Pure logic.

Built reliability-first: **every row reports what was found and what was missing** — you never get a
silent blank, and a run summary tells you exactly what happened.

### What you get

| Field | Description |
|---|---|
| `url` | Url |
| `lastmod` | Lastmod |
| `changefreq` | Changefreq |
| `priority` | Priority |
| `sitemap` | Sitemap |

### How to use it

1. Fill in the input (see the example below).
2. Run it once for a snapshot, or **schedule it** to keep the data fresh.
3. Export to CSV/JSON/Excel, or push straight to Google Sheets, Notion, Airtable, Zapier, Make, or n8n.

### Input

```json
{
  "siteUrl": "https://example.com",
  "sitemapUrls": [],
  "urlIncludes": [],
  "urlExcludes": [],
  "maxUrls": 50000,
  "maxSitemaps": 200,
  "useProxy": false
}
```

### Sample output

```json
[
{
  "url": "https://example.com/item/1",
  "lastmod": "example",
  "changefreq": 12.3,
  "priority": "example",
  "sitemap": "example"
}
]
```

### Typical uses

- **Feed a scraper** — get the URL list, then pass it to a content scraper.
- **Content inventory / SEO** — full page list with lastmod for audits.
- **Change tracking** — schedule and diff `lastmod` to find updated pages.

### Pricing

**$0.50 / 1,000 results** (`$0.0005` per result), plus a near-zero start fee. You are **never charged beyond your limit**, and blocked or
failed items are reported honestly — not billed as data.

### FAQ & limitations

- Reads XML sitemaps (and `.gz`); it doesn't crawl the site if no sitemap exists (it says so).
- Sitemaps behind auth or bot protection are reported in `SUMMARY.problems`, not silently
  dropped — enable the proxy if needed.
- Very large sitemap-index sites are bounded by `maxSitemaps`/`maxUrls` (the cap is reported).
- **Integrations:** output works with Zapier, Make, n8n, and any webhook via Apify's integrations.
- **Formats:** results export as JSON, CSV, Excel, or HTML from the dataset.

### Related actors

- **SSL Certificate Checker**
- **DNS Lookup**
- **HTTP Header Analyzer**

# Actor input Schema

## `siteUrl` (type: `string`):

A site to extract sitemaps from — standard locations (sitemap.xml, sitemap\_index.xml) and robots.txt are tried automatically.

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

Exact sitemap URLs to parse, if you already know them (index or urlset, .xml or .xml.gz).

## `urlIncludes` (type: `array`):

Keep only URLs containing one of these substrings (e.g. /blog/).

## `urlExcludes` (type: `array`):

Drop URLs containing any of these substrings.

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

Hard cap on URLs returned. Strictly enforced.

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

Cap on how many sitemap files to fetch (for huge sitemap-index sites).

## `useProxy` (type: `boolean`):

Route through a proxy for sites that block datacenter IPs.

## Actor input object example

```json
{
  "siteUrl": "https://example.com",
  "sitemapUrls": [],
  "urlIncludes": [],
  "urlExcludes": [],
  "maxUrls": 50000,
  "maxSitemaps": 200,
  "useProxy": false
}
```

# Actor output Schema

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

The dataset of results produced by this run.

# 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 = {
    "siteUrl": "https://example.com",
    "sitemapUrls": [],
    "urlIncludes": [],
    "urlExcludes": [],
    "maxUrls": 50000,
    "maxSitemaps": 200
};

// Run the Actor and wait for it to finish
const run = await client.actor("alaudinburki/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 = {
    "siteUrl": "https://example.com",
    "sitemapUrls": [],
    "urlIncludes": [],
    "urlExcludes": [],
    "maxUrls": 50000,
    "maxSitemaps": 200,
}

# Run the Actor and wait for it to finish
run = client.actor("alaudinburki/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 '{
  "siteUrl": "https://example.com",
  "sitemapUrls": [],
  "urlIncludes": [],
  "urlExcludes": [],
  "maxUrls": 50000,
  "maxSitemaps": 200
}' |
apify call alaudinburki/sitemap-url-extractor --silent --output-dataset

```

## MCP server setup

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