Map overview
POST /v1/crawl/map is the cheapest way to inspect site structure before you spend crawl budget.
Use it when:
- you need candidate URLs first
- you want sitemap-first discovery
- you need to filter to a keyword or area of the site
- you want to decide whether a deeper crawl is worth it
Discover candidate URLs
```bash
curl https://api.faircompany.ai/v1/crawl/map \
-X POST \
-H "Authorization: Bearer fc_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"url": "https://docs.stripe.com",
"limit": 50,
"search": "checkout"
}'
```
```ts
const map = await fc.map({
url: "https://docs.stripe.com",
limit: 50,
search: "checkout",
});
console.log(map.count);
console.log(map.urls[0]);
```
```python
map_result = fc.map(
"https://docs.stripe.com",
limit=50,
search="checkout",
)
print(map_result.count)
print(map_result.urls[0] if map_result.urls else None)
```
```json
{
"tool": "faircrawl_map",
"arguments": {
"url": "https://docs.stripe.com",
"limit": 50,
"search": "checkout"
}
}
```
Output model
Map returns discovered URLs plus their source (sitemap, scrape, or mixed) without fetching full document content for each candidate.