## web/map

`GET /v1/web/map`

Discover a site's URLs from its sitemap.xml (one level of sitemap indexes) with same-origin page links as fallback.

*Map URLs on a site*

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | Site URL to map (http/https, public hosts only) — e.g. `https://example.com` |
| `search` | no | Only return URLs containing this text (case-insensitive) — e.g. `blog` |
| `limit` | no | Maximum URLs to return (default 100, cap 500) — e.g. `100` |
| `sitemap` | no | Sitemap use: include (default: sitemap first, page links as fallback), only, or skip — e.g. `include` |
| `include_subdomains` | no | Also include URLs on subdomains of the site — e.g. `false` |
| `ignore_query_parameters` | no | Strip query strings before deduplicating URLs — e.g. `false` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. — e.g. `1` |

**Cost:** 3 credits at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/web/map?url=https%3A%2F%2Fexample.com" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "_meta": {
    "billing": {
      "charged": 0,
      "list_price": 0,
      "reason": "example"
    }
  },
  "_warnings": [
    "example"
  ],
  "count": 0,
  "discovery": {
    "document_limit_bytes": 0,
    "documents_fetched": 0,
    "max_documents": 0,
    "max_sitemaps": 0,
    "time_limit_ms": 0
  },
  "items": [],
  "limit": 0,
  "origin": "example",
  "sources": [
    "example"
  ],
  "url": "https://example.com/example"
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/web/map#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/web/map.json)