# Sitemap Extractor (urlset + sitemap index) (`tom2turnt/sitemap-extractor`) Actor Parse a sitemap.xml (urlset) or a sitemap index into a clean URL list — loc, lastmod, changefreq, priority — with automatic index detection and de-duplication. Bulk URL discovery to feed downstream scrapers and directory builds. Structured output with ok/error parity. - **URL**: https://apify.com/tom2turnt/sitemap-extractor.md - **Developed by:** [Tommy G](https://apify.com/tom2turnt) (community) - **Categories:** Lead generation, SEO tools, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN 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.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 Extractor (Apify Actor) Give it any public **sitemap URL** (`sitemap.xml` or a sitemap index) and get back a clean, deduped **list of URLs** — each with its `lastmod`, `changefreq`, and `priority` — plus the child sitemaps when the file is an index. HTML-only / XML parsing (no headless browser) so it's fast and cheap. Ideal for **seeding a crawl, change monitoring, and site-coverage audits**. ### What it extracts For each sitemap it returns one flat record with: - **is_index** — whether the file is a sitemap index (points to other sitemaps) or a URL set - **urls[]** — each entry as `{ loc, lastmod, changefreq, priority }` - **sitemaps[]** — for an index, each child sitemap as `{ loc, lastmod }` - **urls_count**, **sitemaps_count** Plus control keys present on **every** row (ok and error alike, for clean buyer tables): `status, requested_url, final_url, http_status, redirected, found, complete, page_type, source, render_required, fields_found, error, extracted_at`. ### Input ```json { "startUrls": [{ "url": "https://example.com/sitemap.xml" }], "maxConcurrency": 5, "maxPages": 100 } ```` `maxPages` capped at 200, `maxConcurrency` at 20 (cost guard). ### Output — one STABLE record per URL (ok *and* error rows share the shape) ```json { "status": "ok", "requested_url": "https://example.com/sitemap.xml", "final_url": "https://example.com/sitemap.xml", "http_status": 200, "found": true, "complete": true, "page_type": "urlset", "source": "xml", "is_index": false, "urls": [ { "loc": "https://example.com/", "lastmod": "2026-05-01", "changefreq": "daily", "priority": 1 }, { "loc": "https://example.com/blog/post", "lastmod": "2026-04-20", "changefreq": "monthly", "priority": 0.8 } ], "sitemaps": [], "urls_count": 2, "sitemaps_count": 0, "extracted_at": "2026-05-29T..." } ``` For a sitemap **index**, `is_index:true` and the child sitemaps appear in `sitemaps[]`. `found:false` means the file held no valid `` entries (e.g. an HTML page or unrelated XML). Failed fetches return the same keys with `status:"error"` + `error`. ### Use cases - **Crawl seeding** — turn a site's sitemap into a clean URL list to feed any of the other extractors next. - **Change monitoring** — track `lastmod` across runs to see which pages were updated. - **Coverage audits** — count and inspect every URL a site declares it wants indexed. ### Notes / safety - Reads only the **public** sitemap a site already publishes for crawlers — facts-only, no PII, no raw page bodies stored. - SSRF-guarded (scheme + private/metadata IP block + redirect re-check), robots-respecting, rate-limited, cost-capped — all via the shared `src/lib/actor_runner.js`. Entry parsing is capped to guard against oversized files. - Handles both XML and HTML-served sitemaps, sitemap indexes, and bare `` fallbacks. Core logic in `src/extract.js` (pure, unit-tested). ### Run locally / test ```bash npm install npm test ## unit tests on the pure extractor (node:test) ``` ### Publish to Apify (account-holder's step) ```bash npm install -g apify-cli && apify login && apify push ``` Keep it free initially; enable pricing later via the adult account-holder once it shows repeat organic usage and clears a margin gate. # Actor input Schema ## `startUrls` (type: `array`): Public sitemap.xml or sitemap-index URLs to parse into a URL list. ## `maxConcurrency` (type: `integer`): Sitemaps parsed in parallel (capped at 20). ## `maxPages` (type: `integer`): Cost guard: maximum sitemaps per run (hard ceiling 200). ## Actor input object example ```json { "startUrls": [ { "url": "https://www.apify.com/sitemap.xml" } ], "maxConcurrency": 5, "maxPages": 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrls": [ { "url": "https://www.apify.com/sitemap.xml" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("tom2turnt/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 = { "startUrls": [{ "url": "https://www.apify.com/sitemap.xml" }] } # Run the Actor and wait for it to finish run = client.actor("tom2turnt/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 '{ "startUrls": [ { "url": "https://www.apify.com/sitemap.xml" } ] }' | apify call tom2turnt/sitemap-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=tom2turnt/sitemap-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Sitemap Extractor (urlset + sitemap index)", "description": "Parse a sitemap.xml (urlset) or a sitemap index into a clean URL list — loc, lastmod, changefreq, priority — with automatic index detection and de-duplication. Bulk URL discovery to feed downstream scrapers and directory builds. Structured output with ok/error parity.", "version": "0.1", "x-build-id": "LnJjltH6BTCrIoFqq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tom2turnt~sitemap-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tom2turnt-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/tom2turnt~sitemap-extractor/runs": { "post": { "operationId": "runs-sync-tom2turnt-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/tom2turnt~sitemap-extractor/run-sync": { "post": { "operationId": "run-sync-tom2turnt-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Sitemap URLs", "type": "array", "description": "Public sitemap.xml or sitemap-index URLs to parse into a URL list.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Sitemaps parsed in parallel (capped at 20).", "default": 5 }, "maxPages": { "title": "Max sitemaps", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cost guard: maximum sitemaps per run (hard ceiling 200).", "default": 100 } } }, "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 } } } } } } } } } } ```