# Sitemap Harvest Seo (`narrow_circle/sitemap-harvest-seo`) Actor

Turn any sitemap into a clean, deduplicated URL list. Follows indexes recursively, handles .xml.gz, include/exclude regex, query stripping, optional lastmod/priority. Ideal for SEO audits, Screaming Frog, RAG, and Zapier/n8n.

- **URL**: https://apify.com/narrow\_circle/sitemap-harvest-seo.md
- **Developed by:** [A Man](https://apify.com/narrow_circle) (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

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## 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 Harvester — Indexes, Gzip & Filters

**Turn any sitemap into a clean, deduplicated URL list** in seconds. Handles sitemap indexes, gzipped sitemaps, and regex filters so you can feed SEO audits, Screaming Frog, RAG pipelines, or Zapier without wrestling XML by hand.

### What it solves

- Client sitemap split across many index files — you need every product URL
- Keep only `/blog/` (or drop `/checkout/`) with one regex
- `.xml.gz` or auto-gzip responses that break lighter tools

### What you get

| Feature | Benefit |
|---------|---------|
| **Multi-sitemap input** | One URL or twenty — indexes followed recursively |
| **Gzip by magic bytes** | Safe decompress even when `fetch` already inflated the body |
| **Regex filtering** | `includeRegex` / `excludeRegex` |
| **Query stripping** | Clean URLs for dedupe |
| **Optional meta** | `lastmod`, `priority`, `changefreq` when `includeMeta: true` |
| **Partial failure safety** | Bad child sitemap → error row; run continues |

### Sample output

```json
{
  "url": "https://apify.com/actors",
  "sourceSitemapUrl": "https://apify.com/sitemap.xml",
  "index": 12,
  "lastmod": "2026-08-01",
  "priority": "0.8",
  "changefreq": "weekly"
}
```

### Who it's for

- SEO agencies building crawl lists
- Content teams inventorying product or blog URLs
- Automation builders feeding **On-Page SEO Audit** or RAG ingest

### Example input

```json
{
  "sitemapUrls": ["https://apify.com/sitemap.xml"],
  "maxUrls": 5000,
  "stripQueryParams": true,
  "includeMeta": true
}
```

### Pricing (when monetised)

| Event | When | Suggested |
|---|---|---|
| **`url-harvested`** | Each page URL written to the dataset | Start **$0.0005–$0.001** / URL → hike after volume |

Error rows are not charged.

### Acceptable use (legal)

- Only harvest sitemaps you are authorised to use (your property, client property, or public sitemaps published for crawlers).
- Private / loopback / metadata hosts are blocked before fetch (SSRF guard).
- Do not use harvested URL lists to attack, spam, or bypass access controls.

### Local test

```bash
npm install && npm test
node src/main.mjs
```

Built by **narrow\_circle**

# Actor input Schema

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

One or more sitemap.xml, sitemap.xml.gz, or sitemap index URLs. Gzip is auto-detected by .gz extension or Content-Encoding.

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

Stop after collecting this many page URLs (from urlsets).

## `maxSitemapDepth` (type: `integer`):

How many hops through sitemapindex files to follow.

## `stripQueryParams` (type: `boolean`):

Normalise URLs by dropping ?query and #fragment.

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

If set, only keep URLs matching this JavaScript regex (full string match not required — use ^…$ if needed).

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

If set, drop URLs matching this regex.

## `delayMs` (type: `integer`):

Optional pause between pushing page URLs to the dataset. Useful for downstream pacing.

## `includeMeta` (type: `boolean`):

If true, includes lastmod, priority, and changefreq from the sitemap <url> block when available.

## Actor input object example

```json
{
  "sitemapUrls": [
    "https://www.example.com/sitemap.xml"
  ],
  "maxUrls": 10000,
  "maxSitemapDepth": 5,
  "stripQueryParams": true,
  "delayMs": 0,
  "includeMeta": false
}
```

# Actor output Schema

## `harvestedUrls` (type: `string`):

Deduplicated page URLs from sitemap indexes/urlsets, with optional lastmod/priority/changefreq.

# 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.example.com/sitemap.xml"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("narrow_circle/sitemap-harvest-seo").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.example.com/sitemap.xml"] }

# Run the Actor and wait for it to finish
run = client.actor("narrow_circle/sitemap-harvest-seo").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.example.com/sitemap.xml"
  ]
}' |
apify call narrow_circle/sitemap-harvest-seo --silent --output-dataset

```

## MCP server setup

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

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/LXLguMq9ht7MlLOus/builds/ea8MWTYWJPcJOEduN/openapi.json