# Sitemap to URL List Extractor (`scrapeworks/sitemap-to-urls`) Actor Extract every URL from any website's sitemap as clean JSON. Handles sitemap indexes (recursive) and gzipped sitemaps automatically. Includes lastmod, priority, and changefreq. - **URL**: https://apify.com/scrapeworks/sitemap-to-urls.md - **Developed by:** [Nicolas van Arkens](https://apify.com/scrapeworks) (community) - **Categories:** Automation, Open source - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $1.00 / 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/platform/actors/running/actors-in-store#pay-per-event ## 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.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.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/platform/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 to URL List Extractor πŸ—ΊοΈ Extract **every URL from any website's sitemap** as clean structured JSON, with last-modified dates, priority, and change frequency. Handles **sitemap indexes** (recursing into nested sitemaps) and **gzipped sitemaps** (`.xml.gz`) automatically β€” the parts most lazy sitemap scrapers get wrong. Perfect for SEO audits, content inventories, building crawl lists, monitoring site changes, and feeding URL lists into other tools. ### Why use it - πŸ” **Recursive sitemap indexes** β€” point it at `sitemap_index.xml` and it'll follow every nested sitemap automatically - πŸ“¦ **Gzipped sitemaps handled** β€” many large sites ship `.xml.gz`, decompressed transparently - πŸ—“οΈ **Full metadata** β€” `lastmod`, `priority`, `changefreq`, plus image URLs from the Google image sitemap extension - πŸ›‘οΈ **Guardrails** β€” configurable caps on total URLs and nested sitemaps so a giant site can't run away - 🌐 **Works on any website** β€” news sites, e-commerce stores, blogs, documentation, public web apps ### Use cases - **SEO audits** β€” list every indexed URL on a site, sort by lastmod, find stale content - **Crawl seed lists** β€” generate URL lists for downstream scrapers or archival tools - **Content inventories** β€” see what a competitor or partner site is actually publishing - **Change monitoring** β€” schedule it and detect newly added pages - **Site migrations** β€” get the full URL set before redirect mapping ### Input | Field | Description | |-------|-------------| | **Sitemap URLs** | One or more sitemap URLs (`sitemap.xml`, `sitemap_index.xml`, or `.xml.gz`). | | **Follow indexes** | If a URL points to an index, recurse and process each nested sitemap. | | **Maximum URLs** | Total URL cap across all sitemaps. | | **Maximum nested sitemaps** | Cap on number of sitemap files fetched when following indexes. | ### Output ```json { "url": "https://example.com/page1", "lastModified": "2025-05-10", "changeFrequency": "weekly", "priority": "0.8", "images": ["https://example.com/img1.jpg"], "sourceSitemap": "https://example.com/sitemap-products.xml", "sourceRoot": "https://example.com/sitemap_index.xml" } ```` Export to JSON, CSV, or Excel, or pull via the Apify API. ### Notes - Supports the standard [sitemaps.org protocol](https://www.sitemaps.org/protocol.html), sitemap index files, and the Google image-sitemap extension. - Always respects each site's `robots.txt` policy on access β€” please use responsibly. - Independent tool; sitemaps remain the property of their publishers. # Actor input Schema ## `sitemapUrls` (type: `array`): One or more sitemap URLs to process. Usually sitename.com/sitemap.xml or sitename.com/sitemap\_index.xml. Gzipped (.xml.gz) sitemaps are handled automatically. ## `followIndexes` (type: `boolean`): If a URL points to a sitemap index (a list of nested sitemaps), automatically follow and process each of them. Turn off to only list the nested sitemap URLs. ## `maxUrls` (type: `integer`): Cap on the total number of URLs to return across all sitemaps. ## `maxNestedSitemaps` (type: `integer`): Cap on how many sitemap files to fetch when following indexes (a guardrail for very large sites with many shards). ## Actor input object example ```json { "sitemapUrls": [ "https://www.apify.com/sitemap.xml" ], "followIndexes": true, "maxUrls": 50000, "maxNestedSitemaps": 50 } ``` # 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 = { "sitemapUrls": [ "https://www.apify.com/sitemap.xml" ] }; // Run the Actor and wait for it to finish const run = await client.actor("scrapeworks/sitemap-to-urls").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 = { "sitemapUrls": ["https://www.apify.com/sitemap.xml"] } # Run the Actor and wait for it to finish run = client.actor("scrapeworks/sitemap-to-urls").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 '{ "sitemapUrls": [ "https://www.apify.com/sitemap.xml" ] }' | apify call scrapeworks/sitemap-to-urls --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scrapeworks/sitemap-to-urls", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Sitemap to URL List Extractor", "description": "Extract every URL from any website's sitemap as clean JSON. Handles sitemap indexes (recursive) and gzipped sitemaps automatically. Includes lastmod, priority, and changefreq.", "version": "0.1", "x-build-id": "CiOwTwZZE8St4kmPC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeworks~sitemap-to-urls/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeworks-sitemap-to-urls", "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/scrapeworks~sitemap-to-urls/runs": { "post": { "operationId": "runs-sync-scrapeworks-sitemap-to-urls", "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/scrapeworks~sitemap-to-urls/run-sync": { "post": { "operationId": "run-sync-scrapeworks-sitemap-to-urls", "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", "properties": { "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "One or more sitemap URLs to process. Usually sitename.com/sitemap.xml or sitename.com/sitemap_index.xml. Gzipped (.xml.gz) sitemaps are handled automatically.", "items": { "type": "string" } }, "followIndexes": { "title": "Follow sitemap indexes", "type": "boolean", "description": "If a URL points to a sitemap index (a list of nested sitemaps), automatically follow and process each of them. Turn off to only list the nested sitemap URLs.", "default": true }, "maxUrls": { "title": "Maximum URLs", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Cap on the total number of URLs to return across all sitemaps.", "default": 50000 }, "maxNestedSitemaps": { "title": "Maximum nested sitemaps", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on how many sitemap files to fetch when following indexes (a guardrail for very large sites with many shards).", "default": 50 } } }, "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 } } } } } } } } } } ```