# Sitemap Extractor: Website → All URLs (sitemap.xml parser) (`boxbox10/sitemap-extractor`) Actor Give it a website. Get every URL from its sitemap — loc, lastmod, changefreq, priority — as one clean record per URL. Auto-discovers sitemap.xml, robots.txt Sitemap: directives, and nested sitemap indexes. Perfect for SEO audits, crawl seeding, and URL discovery. - **URL**: https://apify.com/boxbox10/sitemap-extractor.md - **Developed by:** [Marvin Eguilos](https://apify.com/boxbox10) (community) - **Categories:** AI, Developer tools, Automation - **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/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use 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 Extractor — Website → All URLs (sitemap.xml parser) **Give it a website. Get back every URL from its sitemap.** For each site the Actor auto-discovers the sitemap, parses it, follows nested sitemap indexes, and returns one clean record per URL — `sourceSite`, `url`, `lastmod`, `changefreq`, `priority`. Perfect for SEO audits, seeding a crawler, and fast URL discovery across an entire domain. > Point it at a domain. Walk away with the site's full URL inventory — no scraping, no rendering, no guesswork. --- ### ✨ What it does - **Auto-discovers the sitemap** — tries `/sitemap.xml`, reads `Sitemap:` directives from `robots.txt`, and uses direct sitemap URLs if you pass them. - **Handles sitemap indexes** — recurses into nested `` files (and their children) to gather every child sitemap's URLs. - **One record per URL** — each `` entry becomes one dataset item with its `lastmod`, `changefreq`, and `priority` when present. - **Robust by design** — a site with no sitemap or a fetch error never kills the run: it's routed to a separate `failures` dataset and **never charged**. - **Safe by default** — a `maxUrls` cap bounds run size; recursion depth is capped and loops are de-duplicated so a malformed index can't run away. - **Fast & lightweight** — pure HTTP + a streaming XML parser (`fast-xml-parser`). No browser, no rendering. --- ### 🎯 Use cases | You want to… | This Actor gives you… | |---|---| | **Run an SEO audit** | Every indexed URL with `lastmod` / `changefreq` / `priority` for coverage & freshness checks. | | **Seed a crawler / scraper** | A ready-made URL frontier for your own extraction pipeline — no link discovery needed. | | **Discover a site's structure** | The full URL inventory of a domain, straight from its own sitemap. | | **Monitor content changes** | `lastmod` timestamps to detect new or updated pages between runs. | | **Feed a RAG / AI pipeline** | A clean list of canonical page URLs to fetch and embed downstream. | --- ### 📥 Input | Field | Type | Default | Description | |---|---|---|---| | `urls` | string[] | — **(required)** | One or more website URLs (or direct `sitemap.xml` URLs). Each discovered URL is one result. | | `maxUrls` | integer | `5000` | Safety cap on how many discovered URLs are emitted per run (across all sites). | | `includeLastmod` | boolean | `true` | Include `lastmod`, `changefreq`, and `priority` fields in each result when present. | #### Example input ```json { "urls": [ "https://www.apify.com", "https://example.com" ], "maxUrls": 5000, "includeLastmod": true } ```` *** ### 📤 Output One dataset item per discovered URL: ```json { "sourceSite": "https://www.apify.com/", "url": "https://apify.com/store", "lastmod": "2024-01-15", "changefreq": "daily", "priority": "0.8" } ``` Sites that fail (no sitemap / fetch error) go to a separate `failures` dataset and are **never charged**: ```json { "sourceSite": "https://no-sitemap-here.example/", "error": "No usable sitemap found (tried: https://no-sitemap-here.example/sitemap.xml)", "fetchedAt": "2026-07-19T02:17:19.831Z" } ``` *** ### 🔌 Call it from code (Apify API) ```bash curl -X POST "https://api.apify.com/v2/acts/YOUR_USERNAME~sitemap-extractor/run-sync-get-dataset-items?token=YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"urls":["https://www.apify.com"]}' ``` ```javascript import { ApifyClient } from 'apify-client'; const client = new ApifyClient({ token: 'YOUR_TOKEN' }); const { defaultDatasetId } = await client .actor('YOUR_USERNAME/sitemap-extractor') .call({ urls: ['https://www.apify.com'] }); const { items } = await client.dataset(defaultDatasetId).listItems(); console.log(`${items.length} URLs discovered`); ``` *** ### 💸 Pricing (Pay-Per-Event) | Event | Price | |---|---| | Actor start | **$0.05** per run | | URL found | **$0.0005** per discovered URL | - **You only pay for URLs actually discovered** — sites with no sitemap or a fetch error are never charged. - Per-URL pricing is deliberately low because a single sitemap can yield thousands of URLs. - **🎁 Free tier:** free-plan users' platform usage is covered by Apify, so you can try it and run small jobs at **no cost** before scaling up. *** ### ⚖️ Acceptable use This is a general-purpose sitemap-parsing tool: **you supply the URLs and are responsible for having the right to crawl and use the content you submit.** It only reads the public `robots.txt` and sitemap files each site voluntarily publishes. It does not render pages, does not target any single platform's private API, and does not harvest personal data. Please use responsibly and comply with each site's terms of service and applicable law. *** ### 🧱 Under the hood Node.js · [got-scraping](https://github.com/apify/got-scraping) · [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) · Apify SDK. Stateless — nothing is stored between runs. # Actor input Schema ## `urls` (type: `array`): One or more website URLs (or direct sitemap.xml URLs). For each site the Actor discovers its sitemap and emits every URL it contains. Each discovered URL is one billable result. ## `maxUrls` (type: `integer`): Safety cap on how many discovered URLs are emitted in a single run (across all sites). ## `includeLastmod` (type: `boolean`): Include the optional sitemap fields (lastmod, changefreq, priority) in each result when present. ## Actor input object example ```json { "urls": [ "https://www.apify.com" ], "maxUrls": 5000, "includeLastmod": true } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "urls": [ "https://www.apify.com", "https://example.com" ] }; // Run the Actor and wait for it to finish const run = await client.actor("boxbox10/sitemap-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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "urls": [ "https://www.apify.com", "https://example.com", ] } # Run the Actor and wait for it to finish run = client.actor("boxbox10/sitemap-extractor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "urls": [ "https://www.apify.com", "https://example.com" ] }' | apify call boxbox10/sitemap-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=boxbox10/sitemap-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Sitemap Extractor: Website → All URLs (sitemap.xml parser)", "description": "Give it a website. Get every URL from its sitemap — loc, lastmod, changefreq, priority — as one clean record per URL. Auto-discovers sitemap.xml, robots.txt Sitemap: directives, and nested sitemap indexes. Perfect for SEO audits, crawl seeding, and URL discovery.", "version": "0.1", "x-build-id": "F7ojNeaIaaXIhLaww" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boxbox10~sitemap-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boxbox10-sitemap-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/boxbox10~sitemap-extractor/runs": { "post": { "operationId": "runs-sync-boxbox10-sitemap-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/boxbox10~sitemap-extractor/run-sync": { "post": { "operationId": "run-sync-boxbox10-sitemap-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "urls" ], "properties": { "urls": { "title": "Website URLs", "type": "array", "description": "One or more website URLs (or direct sitemap.xml URLs). For each site the Actor discovers its sitemap and emits every URL it contains. Each discovered URL is one billable result.", "items": { "type": "string" } }, "maxUrls": { "title": "Max URLs per run", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Safety cap on how many discovered URLs are emitted in a single run (across all sites).", "default": 5000 }, "includeLastmod": { "title": "Include lastmod / changefreq / priority", "type": "boolean", "description": "Include the optional sitemap fields (lastmod, changefreq, priority) in each result when present.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```