# Sitemap & On-Page Crawl (`timbered_oak/sitemap-and-onpage-crawl`) Actor

Discovers a site's sitemap via robots.txt, crawls up to maxPages pages with CheerioCrawler, and returns per-page SEO/on-page metrics.

- **URL**: https://apify.com/timbered\_oak/sitemap-and-onpage-crawl.md
- **Developed by:** [Mark](https://apify.com/timbered_oak) (community)
- **Categories:** SEO tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$4.20 / 1,000 page analyzeds

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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 & On-Page Crawl

### What it does

Discovers a site's sitemap (via `robots.txt`, falling back to `/sitemap.xml`
or `/sitemap.txt`), respects `robots.txt` disallow rules, then crawls up to
`maxPages` of the listed pages with Crawlee's `CheerioCrawler` and returns
one on-page SEO/metrics row per page.

### Input

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string | yes | Any URL on the target site — its origin's robots.txt/sitemap is used. |
| `maxPages` | integer | no | Max pages to crawl (default 100). |

### Output example

One row per crawled page in the default dataset:

```json
{
  "url": "https://crawlee.dev/blog",
  "status": 200,
  "title": "Crawlee Blog - learn how to build better scrapers | Crawlee for JavaScript · Build reliable crawlers. Fast.",
  "metaDescription": "Guides and tutorials on using Crawlee, the most reliable open-source web scraping and browser automation library for JavaScript and Node.js developers.",
  "h1": null,
  "canonical": "https://crawlee.dev/blog",
  "wordCount": 1370,
  "internalLinks": 82,
  "externalLinks": 64,
  "imagesWithoutAlt": 0,
  "loadMs": 471
}
```

### Pricing

Pay-per-event (PPE). One `page-analyzed` event is charged per dataset row
via `Actor.charge({ eventName: 'page-analyzed' })` — never charged for a
page that errors before a row is pushed. Configure the event at
**$0.0042/page-analyzed** in the Apify Console pricing step (`policy/RULES.md`
rule 3: ~10% under `apify/sitemap-extractor`'s $0.0005/item baseline
scaled to a full on-page pass, and 10x under the $0.04/page audit-tool
alternative).

### Limits

Free-plan compute only (`policy/RULES.md` rule 4). No residential proxy
needed. JS-rendered content is not executed (Cheerio, not a browser) — pages
that inject title/meta/h1 via client-side JS will show blank/null for those
fields. No personal data in output (rule 1).

# Actor input Schema

## `url` (type: `string`):

Any URL on the target site. Its origin's robots.txt / sitemap.xml is used to discover pages.

## `maxPages` (type: `integer`):

Maximum number of sitemap pages to crawl and analyze.

## Actor input object example

```json
{
  "url": "https://crawlee.dev",
  "maxPages": 20
}
```

# Actor output Schema

## `results` (type: `string`):

All scraped rows as JSON

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "url": "https://crawlee.dev",
    "maxPages": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("timbered_oak/sitemap-and-onpage-crawl").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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "url": "https://crawlee.dev",
    "maxPages": 20,
}

# Run the Actor and wait for it to finish
run = client.actor("timbered_oak/sitemap-and-onpage-crawl").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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://crawlee.dev",
  "maxPages": 20
}' |
apify call timbered_oak/sitemap-and-onpage-crawl --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,timbered_oak/sitemap-and-onpage-crawl"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/VcfmBGebW1uR0lDSt/builds/EqGgeItdKnWAbD5nP/openapi.json