API reference
Map Site
POST /map · Map and crawl
POSThttps://api.clawifi.dev/map1 credit per started 10 URLs returned
- Send your key as
Authorization: Bearer $CLAWIFI_API_KEY; see Authentication. - Add
"dry_run": true(or?dry_run=true) to see what the call would cost; nothing runs and nothing is charged. - Hosted MCP tool:
map_siteonhttps://api.clawifi.dev/mcp. - Credits: 1 per started 10 URLs returned (at least 1). Every price is on Pricing and credits.
Request#
curl -X POST https://api.clawifi.dev/map \
-H "Authorization: Bearer $CLAWIFI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com"}'from clawifi import Clawifi
client = Clawifi() # reads CLAWIFI_API_KEY
result = client.map("https://example.com")map_site(url="https://example.com")Body
| Field | Type | Default | Required |
|---|---|---|---|
allow_subdomains | boolean | false | no |
browser_profile | string (optional) | no | |
force_browser | boolean | false | no |
ignore_query_params | boolean | true | no |
max_urls | integer | 100 | no |
robots_policy | "respect" | "ignore" | "respect" | no |
same_domain_only | boolean | true | no |
search | string (optional) | no | |
sources | array of "robots" | "sitemap" | "html_links" | "rss" | "docs_paths" | no | |
timeout_seconds | integer (optional) | no | |
url | string | yes | |
wait_until | "commit" | "domcontentloaded" | "load" | "networkidle" | "domcontentloaded" | no |
Response#
200 with a MapResponse object: discovered_count, errors, success, url, urls.
Errors use the shared shape; see Errors. Try public operations without a key in the playground.
Was this page helpful? Tell us · Last updated 2026-10-22