# Public Sitemap & Crawl Scope Planner (`jacksu/public-sitemap-crawl-scope-planner`) Actor Turn public robots.txt and sitemap XML into crawl-scope briefs with URL inventory, path groups, seed URLs, freshness, diagnostics, and useful-result pricing. - **URL**: https://apify.com/jacksu/public-sitemap-crawl-scope-planner.md - **Developed by:** [jack su](https://apify.com/jacksu) (community) - **Categories:** SEO tools, Developer tools, AI - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $5.00 / 1,000 useful crawl scope 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 ## Public Sitemap & Crawl Scope Planner Turn public `robots.txt` and sitemap XML into a bounded, AI-ready site index: sitemap URLs, sampled declared pages, page-type counts, path groups, recommended seed URLs, lastmod freshness, robots rules, source evidence, confidence, and diagnostics. This Actor is for SEO, RAG preparation, AI-agent browsing, monitoring, and content operations teams that need a predictable URL inventory before deciding whether to crawl or process a website. ### What It Returns - Sanitized site origin and robots URL - Same-site sitemap files read - Declared sitemap URL count - Sampled public URLs with lastmod, changefreq, priority, and page type - Page type counts - Path groups and recommended seed URLs - Latest lastmod value - Freshness summary - Robots user agents, allow/disallow samples, crawl delay, and rule count - Site index hash - Evidence URLs - Confidence, completeness, missing fields, diagnostics, and readable errors ### Pricing Design The intended pay-per-event setup is: - `apify-actor-start`: a tiny run-start fee - `useful-crawl-scope-result`: charged only for useful public crawl-scope records with at least one same-site URL entry - no `apify-default-dataset-item` Robots-only, missing-sitemap, duplicate, private-network, invalid-input, and failed records should not charge the useful crawl-scope event. ### Good Fits - Planning crawl scope before a crawl - Feeding RAG pipelines with sitemap URL candidates - Checking whether a website exposes usable sitemap metadata - SEO/content inventory triage - Building agent-friendly site maps without rendering pages ### Boundaries This Actor does not crawl arbitrary pages, log in, use cookies, render JavaScript, take screenshots, scrape search engines, scrape social platforms, or enrich private persons. It reads only public same-site `robots.txt` and sitemap resources. Credentials, query parameters, fragments, private-network addresses, localhost, `.local`, external sitemap files, and external page URLs are rejected, skipped, or safely redacted. # Actor input Schema ## `sites` (type: `array`): Public site origins or domains. Query parameters, fragments, credentials, and private-network addresses are rejected. ## `maxSitemapsPerSite` (type: `integer`): Maximum number of same-site sitemap files to read per site. ## `maxUrlsPerSite` (type: `integer`): Maximum same-site sitemap URL entries to collect per site. ## `requestTimeoutSecs` (type: `integer`): Maximum time in seconds to wait for each robots or sitemap request. ## Actor input object example ```json { "sites": [ "https://apify.com" ], "maxSitemapsPerSite": 5, "maxUrlsPerSite": 200, "requestTimeoutSecs": 20 } ```` # Actor output Schema ## `datasetId` (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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("jacksu/public-sitemap-crawl-scope-planner").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 = {} # Run the Actor and wait for it to finish run = client.actor("jacksu/public-sitemap-crawl-scope-planner").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 '{}' | apify call jacksu/public-sitemap-crawl-scope-planner --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jacksu/public-sitemap-crawl-scope-planner", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Public Sitemap & Crawl Scope Planner", "description": "Turn public robots.txt and sitemap XML into crawl-scope briefs with URL inventory, path groups, seed URLs, freshness, diagnostics, and useful-result pricing.", "version": "0.1", "x-build-id": "i5Jxd1KrDGfbH09Ab" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jacksu~public-sitemap-crawl-scope-planner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jacksu-public-sitemap-crawl-scope-planner", "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/jacksu~public-sitemap-crawl-scope-planner/runs": { "post": { "operationId": "runs-sync-jacksu-public-sitemap-crawl-scope-planner", "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/jacksu~public-sitemap-crawl-scope-planner/run-sync": { "post": { "operationId": "run-sync-jacksu-public-sitemap-crawl-scope-planner", "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": [ "sites" ], "properties": { "sites": { "title": "Sites", "minItems": 1, "maxItems": 20, "type": "array", "description": "Public site origins or domains. Query parameters, fragments, credentials, and private-network addresses are rejected.", "items": { "type": "string" }, "default": [ "https://apify.com" ] }, "maxSitemapsPerSite": { "title": "Maximum sitemaps per site", "minimum": 1, "maximum": 8, "type": "integer", "description": "Maximum number of same-site sitemap files to read per site.", "default": 5 }, "maxUrlsPerSite": { "title": "Maximum URLs per site", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum same-site sitemap URL entries to collect per site.", "default": 200 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum time in seconds to wait for each robots or sitemap request.", "default": 20 } } }, "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 } } } } } } } } } } ```