map_site
Discover a website's URLs by reading sitemap.xml or following links, returning a clean site map without fetching page bodies. Ideal for site audits and navigation planning.
Instructions
Use this to list a site's URLs without fetching page bodies - reads sitemap.xml when available, otherwise follows links. Not for page content (scrape, or crawl_deep for many pages) and not for the links on one page (extract_links). Cost: 2 credits. Example: map_site({url: "https://example.com", include_sitemap: true, max_urls: 500})
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The website URL to map | |
| search | No | When set, rank discovered URLs by relevance to this string and emit ranked_urls:[{url,score}] | |
| max_urls | No | Maximum number of URLs to discover | |
| user_agent | No | Override the outbound User-Agent. CrawlForge identifies itself honestly by default; use this only for targets you have your own agreement with. | |
| domain_filter | No | Per-domain allow/deny lists and URL include/exclude patterns | |
| group_by_path | No | Group URLs by path segments | |
| respect_robots | No | Respect the target site's robots.txt (default: true). Setting this to false is honoured, returns a warning in the response, and is recorded against your API key — it is your decision, not a silent default. | |
| include_sitemap | No | Include sitemap.xml data in results | |
| include_metadata | No | Include page metadata for each URL | |
| import_filter_config | No | JSON string of a previously exported domain-filter config |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| urls | No | Flat array of URLs, or grouped-by-path object when group_by_path=true (default) | |
| _cost | No | Cost-transparency metadata (D3.5), present when injected into the text copy of the result | |
| base_url | No | ||
| metadata | No | Per-URL metadata when include_metadata=true | |
| site_map | No | ||
| statistics | No | ||
| total_urls | No | ||
| ranked_urls | No | Present only when the `search` param was set | |
| filter_stats | No | ||
| domain_filter_config | No |