# Sitemap Generator (`gentle_cloud/sitemap-generator`) Actor

Crawl websites and generate XML sitemaps with configurable depth and page limits. Discover all pages, extract metadata, and output a ready-to-use sitemap.xml.

- **URL**: https://apify.com/gentle_cloud/sitemap-generator.md
- **Developed by:** [Monkey Coder](https://apify.com/gentle_cloud) (community)
- **Categories:** SEO tools, Other
- **Features:** Limited permissions
- **Stats:** 8 total users, 0 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.01 / actor start

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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 Generator

Generate XML sitemaps by crawling websites with configurable depth and page limits.

### What it does

Sitemap Generator starts from one or more URLs, crawls internal links using breadth-first traversal, and produces:

- Per-page crawl metadata in the Apify dataset
- A complete XML sitemap string for each start URL

This actor is designed for SEO discovery, site inventory checks, and quick sitemap generation from live websites.

### Features

- Crawls internal links only (same domain/subdomain family)
- Breadth-first traversal with `max_depth` and `max_pages`
- Handles relative URLs, fragments, query strings, redirects, and timeouts
- Skips common non-HTML/static resources (images, CSS, JS, PDFs, archives, media)
- Extracts page title, approximate word count, link counts, and HTTP metadata
- Outputs XML sitemap in standard `urlset` format

### How to use

1. Provide one or more **Start URLs**.
2. Set **Maximum Crawl Depth** (default `3`).
3. Set **Maximum Pages** per start URL (default `100`).
4. Run the actor.

The actor writes one dataset item per discovered page with crawl metrics. For each start URL, the first dataset item includes `sitemap_xml` for all pages discovered in that crawl.

### Input

- `start_urls` (array, requestListSources editor)
- `max_depth` (integer, default `3`)
- `max_pages` (integer, default `100`)

### Sample output JSON

```json
{
  "url": "https://example.com/docs",
  "depth": 1,
  "status_code": 200,
  "content_type": "text/html; charset=utf-8",
  "title": "Documentation | Example",
  "last_modified": "Tue, 12 Mar 2024 09:12:11 GMT",
  "word_count": 842,
  "internal_links_count": 34,
  "external_links_count": 6,
  "sitemap_xml": null,
  "total_pages_found": 57,
  "crawl_started_at": "2026-03-18T12:34:56.000000+00:00"
}
```

Example first item for a crawl includes `sitemap_xml`:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://example.com</loc>
    <lastmod>2026-03-18</lastmod>
    <priority>1.0</priority>
  </url>
</urlset>
```

### Notes about limits

- `max_depth` and `max_pages` are safety limits; higher values increase run time and request volume.
- Only HTTP/HTTPS pages are crawled.
- Some sites block crawlers or require JavaScript rendering; this actor performs pure HTTP crawling.
- `word_count` is an approximation derived from visible page text.

# Actor input Schema

## `start_urls` (type: `array`):

List of website URLs where crawling starts.

## `max_depth` (type: `integer`):

Maximum link depth from each start URL. Depth 0 means only the start page.

## `max_pages` (type: `integer`):

Maximum number of pages to crawl per start URL.

## Actor input object example

```json
{
  "start_urls": [
    {
      "url": "https://crawlee.dev"
    }
  ],
  "max_depth": 3,
  "max_pages": 100
}
```

# 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 = {
    "start_urls": [
        {
            "url": "https://crawlee.dev"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("gentle_cloud/sitemap-generator").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 = { "start_urls": [{ "url": "https://crawlee.dev" }] }

# Run the Actor and wait for it to finish
run = client.actor("gentle_cloud/sitemap-generator").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 '{
  "start_urls": [
    {
      "url": "https://crawlee.dev"
    }
  ]
}' |
apify call gentle_cloud/sitemap-generator --silent --output-dataset

```

## MCP server setup

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

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/ZrVQ0DLgUUhYn8fZt/builds/EQ8gPc7BoA0omFNcG/openapi.json