# sitemap-api.com (`sitemap-api/sitemap-api-com`) Actor

- **URL**: https://apify.com/sitemap-api/sitemap-api-com.md
- **Developed by:** [sitemap-api](https://apify.com/sitemap-api) (community)
- **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/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Sitemap Extractor (powered by sitemap-api.com)

Get a complete, automatically refreshed sitemap and URL list for any website, without running a crawler yourself.

### What it does

- Returns every URL in a domain's sitemap, with `lastmod`, `changefreq` and `priority`
- Follows sitemap index files and removes duplicate URLs
- Domains that aren't in the crawler yet can be added automatically, so they're ready on your next run
- Optionally saves the raw `sitemap.xml` for download

### Use cases

- SEO audits and content inventories
- Feeding URL lists into scrapers, link checkers or LLM pipelines
- Monitoring competitors for new pages (schedule this Actor and compare runs)

### Input

| Field | Description |
|---|---|
| `domains` | Domains or URLs, e.g. `example.com` |
| `outputMode` | `perUrl` (one row per URL) or `perDomain` (one row per domain with nested URLs) |
| `maxUrlsPerDomain` | Cap on URLs per domain, `0` = unlimited |
| `submitMissingDomains` | Add unknown domains to the crawler |
| `saveRawXml` | Store each sitemap.xml in the key-value store |

### Output example (`perUrl`)

```json
{
  "domain": "example.com",
  "url": "https://example.com/about",
  "lastmod": "2026-10-20",
  "changefreq": "weekly",
  "priority": "0.8",
  "sitemapUrl": "https://sitemap-api.com/sitemap/example-com.xml",
  "checkedAt": "2026-10-23T15:47:26Z"
}
```

Domains without a sitemap yet return a row with `status: "queued"` or `"not_found"`.

### Pricing

Pay per event: you're charged once per domain whose sitemap is delivered. Domains that aren't found yet are not charged for a sitemap.

### Freshness

Sitemaps are regenerated by sitemap-api.com every 1–3 days. For your own sites with a fixed cron job or Search Console link, see [sitemap-api.com](https://sitemap-api.com).

# Actor input Schema

## `domains` (type: `array`):

Domains or URLs to get sitemaps for, e.g. example.com or https://www.example.com.

## `outputMode` (type: `string`):

One dataset row per URL (easy to export to CSV) or one row per domain with all URLs nested.

## `maxUrlsPerDomain` (type: `integer`):

Limit the number of URLs returned per domain. 0 means no limit.

## `submitMissingDomains` (type: `boolean`):

If a domain has no sitemap yet, add it to the sitemap-api.com crawler so it is ready on a later run.

## `saveRawXml` (type: `boolean`):

Also store each sitemap.xml in the key-value store for download.

## Actor input object example

```json
{
  "domains": [
    "example.com"
  ],
  "outputMode": "perUrl",
  "maxUrlsPerDomain": 0,
  "submitMissingDomains": true,
  "saveRawXml": false
}
```

# Actor output Schema

## `urls` (type: `string`):

One row per URL (or per domain, depending on output format) with lastmod, changefreq, priority and status.

## `summary` (type: `string`):

Counts of sitemaps delivered, domains queued, domains not found and errors.

## `rawSitemaps` (type: `string`):

The original sitemap.xml for each domain. Only present when 'Save raw sitemap.xml files' is enabled.

# 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 = {
    "domains": [
        "example.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("sitemap-api/sitemap-api-com").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 = { "domains": ["example.com"] }

# Run the Actor and wait for it to finish
run = client.actor("sitemap-api/sitemap-api-com").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 '{
  "domains": [
    "example.com"
  ]
}' |
apify call sitemap-api/sitemap-api-com --silent --output-dataset

```

## MCP server setup

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

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/7ohWGZ65HciI8PzBh/builds/ygXVCvdoweohK91N2/openapi.json