# Page to API - Sitemap to JSON (`timely_quarterstaff/page-to-api-extractor`) Actor Turn any public site URL or sitemap.xml into a clean API-style JSON feed. Crawls a bounded set of pages (hard cap 50/run) and returns one structured record per page: title, meta, headings, links, main text, JSON-LD + OpenGraph. SSRF-guarded, pure code, no AI by default. - **URL**: https://apify.com/timely\_quarterstaff/page-to-api-extractor.md - **Developed by:** [Ahmed Moussa](https://apify.com/timely_quarterstaff) (community) - **Categories:** Developer tools - **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.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 ## Page to API — Sitemap to JSON Turn any public site URL or `sitemap.xml` into a clean, API-style JSON feed. ### What it does Give it a page URL or a sitemap, and it crawls a **bounded** set of pages and returns one structured record per page (title, meta, headings, links, JSON-LD, OpenGraph and main text). ### What you get per page ```json { "url": "https://example.com/", "status": "ok", "fetched_at": "2026-06-23T12:00:00+00:00", "title": "Example Domain", "meta_description": "...", "meta": { "og:title": "...", "description": "..." }, "headings": [ { "level": "h1", "text": "Example Domain" } ], "links": [ { "href": "https://www.iana.org/domains/example", "text": "More information..." } ], "structured_data": [ { "@context": "https://schema.org", "@type": "WebPage" } ], "main_text": "Example Domain This domain is for use in...", "word_count": 28 } ```` ### Input | Field | Type | Default | Notes | |---|---|---|---| | `url` | string | — | A single page URL. If it points to a sitemap it is crawled as one. | | `sitemap_url` | string | — | A `sitemap.xml` (or sitemap index) URL. | | `max_pages` | integer | 20 | Bounded crawl cap. **Hard-capped at 50 per run.** | | `llm_api_key` | string (secret) | — | Optional, your own key. The default path uses **no AI**. | Provide either `url` or `sitemap_url`. ### Output One item per page is pushed to the actor's default dataset (see the per-page schema above). ### Use cases - Headless-CMS-style JSON feed from a static or marketing site. - Bulk-ingest a site's pages (via sitemap) into a search index or RAG pipeline. - Snapshot a site's structured data (JSON-LD / OpenGraph) for monitoring. ### How it works (deterministic, code-only) Each URL (and every sitemap entry) is fetched through an SSRF-guarded client and parsed with regex + stdlib into title, meta, headings, links, JSON-LD, OpenGraph and main text. The crawl is hard-capped at 50 pages/run. No AI on the default path. ### Cost-safety & security (always on) - **Deterministic, code-only** parsing (regex + stdlib). **No LLM, no paid API by default** → no per-run AI/API cost. - **Bounded crawl cap**: at most `max_pages` pages, hard-ceilinged at **50** regardless of input, so a run can never explode compute/cost. - **SSRF guard**: every fetch (including the sitemap and every redirect hop) is re-validated; private / loopback / link-local / reserved IPs are blocked (fail-closed). - **Bounded fetch**: hard size cap (2 MB/page), connect/read timeouts, max 3 redirects, content-type allowlist. - **Domain blocklist** for login-walled / ToS-sensitive sites. - The extractor **never hangs or raises** — any failure yields a record with a non-`ok` `status` and an `error` message. ### Limitations (honest) - Hard cap of 50 pages per run — for larger sites, page through multiple runs. - Client-side-rendered pages (heavy JS) expose less content; there is no headless browser. - Login-walled / blocklisted domains are refused with a non-`ok` status. # Actor input Schema ## `url` (type: `string`): A single public page URL to extract. If it points to a sitemap.xml it will be crawled as a sitemap. Provide either this or 'sitemap\_url'. ## `sitemap_url` (type: `string`): Optional. A public sitemap.xml (or sitemap index) URL. A BOUNDED set of its pages (up to max\_pages) is crawled and returned. ## `max_pages` (type: `integer`): Maximum number of pages to crawl from a sitemap. Default 20. Hard-capped at 50 per run so a single run can never explode compute/cost. ## `llm_api_key` (type: `string`): Optional. Reserved for optional AI enrichment using YOUR own key. The default extraction is fully deterministic and uses NO AI and NO paid API. ## Actor input object example ```json { "url": "https://quotes.toscrape.com", "max_pages": 20 } ``` # 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 = { "url": "https://quotes.toscrape.com" }; // Run the Actor and wait for it to finish const run = await client.actor("timely_quarterstaff/page-to-api-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 = { "url": "https://quotes.toscrape.com" } # Run the Actor and wait for it to finish run = client.actor("timely_quarterstaff/page-to-api-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 '{ "url": "https://quotes.toscrape.com" }' | apify call timely_quarterstaff/page-to-api-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=timely_quarterstaff/page-to-api-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Page to API - Sitemap to JSON", "description": "Turn any public site URL or sitemap.xml into a clean API-style JSON feed. Crawls a bounded set of pages (hard cap 50/run) and returns one structured record per page: title, meta, headings, links, main text, JSON-LD + OpenGraph. SSRF-guarded, pure code, no AI by default.", "version": "0.1", "x-build-id": "x4mmrKRfnxBIYbWMl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/timely_quarterstaff~page-to-api-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-timely_quarterstaff-page-to-api-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/timely_quarterstaff~page-to-api-extractor/runs": { "post": { "operationId": "runs-sync-timely_quarterstaff-page-to-api-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/timely_quarterstaff~page-to-api-extractor/run-sync": { "post": { "operationId": "run-sync-timely_quarterstaff-page-to-api-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": { "url": { "title": "Page URL", "type": "string", "description": "A single public page URL to extract. If it points to a sitemap.xml it will be crawled as a sitemap. Provide either this or 'sitemap_url'." }, "sitemap_url": { "title": "Sitemap URL", "type": "string", "description": "Optional. A public sitemap.xml (or sitemap index) URL. A BOUNDED set of its pages (up to max_pages) is crawled and returned." }, "max_pages": { "title": "Max pages (bounded crawl cap)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of pages to crawl from a sitemap. Default 20. Hard-capped at 50 per run so a single run can never explode compute/cost.", "default": 20 }, "llm_api_key": { "title": "LLM API key (optional, your own key)", "type": "string", "description": "Optional. Reserved for optional AI enrichment using YOUR own key. The default extraction is fully deterministic and uses NO AI and NO paid API." } } }, "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 } } } } } } } } } } ```