# Sitemap URL Extractor (`cool_ya/sitemap-url-extractor`) Actor Discover and parse XML sitemaps for any website. Returns every URL with lastmod, changefreq and priority. Handles sitemap indexes, gzipped and plain-text sitemaps. - **URL**: https://apify.com/cool\_ya/sitemap-url-extractor.md - **Developed by:** [Y A](https://apify.com/cool_ya) (community) - **Categories:** Developer tools, SEO tools - **Stats:** 2 total users, 1 monthly users, 0.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.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 URL Extractor **Extract every URL from any website's XML sitemap โ€” in seconds, with no code.** Point this Actor at a domain or a sitemap URL and get back a clean, structured list of every page the site publishes, complete with `lastmod`, `changefreq`, and `priority` metadata. Perfect for **SEO audits, content inventories, site migrations, crawl seeding, and competitive research**. ### What it does - ๐Ÿ” **Auto-discovers sitemaps** from a bare domain via `robots.txt` and common well-known paths (`/sitemap.xml`, `/sitemap_index.xml`, WordPress `/wp-sitemap.xml`, and more). - ๐Ÿ—‚๏ธ **Follows sitemap indexes** recursively โ€” nested sitemaps are crawled automatically. - ๐Ÿ—œ๏ธ **Handles gzipped** (`.xml.gz`) and **plain-text** sitemaps transparently. - ๐Ÿงน **De-duplicates** URLs across multiple sitemaps. - โšก **HTTP-only and fast** โ€” no headless browser, so runs are cheap and quick. ### Input | Field | Type | Description | |-------|------|-------------| | `startUrls` | array | List of domains or sitemap URLs. Domains are auto-discovered; sitemap URLs are parsed directly. | | `url` | string | Convenience field for a single target. | | `maxUrls` | integer | Max URLs to return (0 = unlimited). Default `0`. | | `includeSubSitemaps` | boolean | Recursively follow sitemap-index files. Default `true`. | #### Example input ```json { "startUrls": ["https://example.com"], "maxUrls": 0, "includeSubSitemaps": true } ```` ### Output Each dataset item is one URL: ```json { "url": "https://example.com/blog/hello-world", "lastmod": "2025-01-15", "changefreq": "weekly", "priority": "0.8", "sourceSitemap": "https://example.com/sitemap.xml" } ``` You can export results as **JSON, CSV, Excel, or via API** directly from the run. ### Pricing This Actor is billed **per result** โ€” you pay only for the URLs it actually extracts. No subscription, no minimum. Runs that find nothing cost nothing beyond the negligible start event. ### Notes - The Actor respects standard sitemap conventions and identifies itself with a clear User-Agent. - If a site has no discoverable sitemap, the run completes cleanly with zero results. # Actor input Schema ## `startUrls` (type: `array`): A list of websites (domains) or direct sitemap URLs. For domains, the Actor auto-discovers sitemaps via robots.txt and common paths. For sitemap URLs, it parses them directly (indexes and gzipped sitemaps supported). ## `url` (type: `string`): Optional convenience field for a single target. Use 'startUrls' for multiple. ## `maxUrls` (type: `integer`): Maximum number of URLs to extract across all sitemaps. Set to 0 for unlimited. ## `includeSubSitemaps` (type: `boolean`): When enabled, the Actor recursively follows nested sitemaps referenced in a sitemap index file. ## Actor input object example ```json { "startUrls": [ "https://example.com", "https://example.com/sitemap.xml" ], "maxUrls": 0, "includeSubSitemaps": true } ``` # Actor output Schema ## `results` (type: `string`): No description # 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": [ "https://apify.com" ] }; // Run the Actor and wait for it to finish const run = await client.actor("cool_ya/sitemap-url-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": ["https://apify.com"] } # Run the Actor and wait for it to finish run = client.actor("cool_ya/sitemap-url-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": [ "https://apify.com" ] }' | apify call cool_ya/sitemap-url-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=cool_ya/sitemap-url-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Sitemap URL Extractor", "description": "Discover and parse XML sitemaps for any website. Returns every URL with lastmod, changefreq and priority. Handles sitemap indexes, gzipped and plain-text sitemaps.", "version": "0.1", "x-build-id": "eusF8Z7iEvsdUIoSi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cool_ya~sitemap-url-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cool_ya-sitemap-url-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/cool_ya~sitemap-url-extractor/runs": { "post": { "operationId": "runs-sync-cool_ya-sitemap-url-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/cool_ya~sitemap-url-extractor/run-sync": { "post": { "operationId": "run-sync-cool_ya-sitemap-url-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", "properties": { "startUrls": { "title": "Websites or sitemap URLs", "type": "array", "description": "A list of websites (domains) or direct sitemap URLs. For domains, the Actor auto-discovers sitemaps via robots.txt and common paths. For sitemap URLs, it parses them directly (indexes and gzipped sitemaps supported).", "items": { "type": "string" } }, "url": { "title": "Single website or sitemap URL", "type": "string", "description": "Optional convenience field for a single target. Use 'startUrls' for multiple." }, "maxUrls": { "title": "Maximum URLs", "minimum": 0, "type": "integer", "description": "Maximum number of URLs to extract across all sitemaps. Set to 0 for unlimited.", "default": 0 }, "includeSubSitemaps": { "title": "Follow sitemap indexes", "type": "boolean", "description": "When enabled, the Actor recursively follows nested sitemaps referenced in a sitemap index file.", "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 } } } } } } } } } } ```