> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindcase.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Web Map API

> Every URL on a website in one call: sitemaps plus link discovery, with each URL's last-modified date and where it was found. One row per site, up to 5,000 URLs, $0.002 per site. Pass the site URLs.

`POST /v1/data/web/map/run`

**Pricing:** $0.002 per site ($2.00 per 1,000).

## Request

Send the inputs under `params`. Only the keys below are accepted; any other key returns `422 invalid_params`.

**urls** `string[]` *required*

Sites to map, like [https://example.com](https://example.com). Each site is one row and one charge.

**maxUrls** `integer` (default: 5000)

How many URLs to return for each site. Defaults to 5,000, the most a site can return.

Min `1`; max `5000`.

## Example

```bash cURL theme={null}
curl -X POST "https://api.mindcase.co/v1/data/web/map/run?wait=true" \
  -H "Authorization: Bearer $MINDCASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": {
    "urls": [
      "https://www.mindcase.co",
      "https://wireguard.com",
      "https://no-such-site-zq9x7.com"
    ]
  }
}'
```

```python Python theme={null}
import os, requests

r = requests.post(
    "https://api.mindcase.co/v1/data/web/map/run",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['MINDCASE_API_KEY']}"},
    json={"params": {
    "urls": [
        "https://www.mindcase.co",
        "https://wireguard.com",
        "https://no-such-site-zq9x7.com"
    ]
}},
)
job = r.json()
rows = job.get("data", [])  # if job["status"] == "running", poll /v1/jobs/{job_id}/results
```

```javascript Node.js theme={null}
const r = await fetch("https://api.mindcase.co/v1/data/web/map/run?wait=true", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MINDCASE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ params: {
  "urls": [
    "https://www.mindcase.co",
    "https://wireguard.com",
    "https://no-such-site-zq9x7.com"
  ]
} }),
});
const job = await r.json();
const rows = job.data ?? []; // if job.status === "running", poll /v1/jobs/{job_id}/results
```

## Response fields

Each row in `data` is one site, keyed by these fields.

| Field | Name | Type |
| - | - | - |
| `site` | Site | text |
| `domain` | Domain | text |
| `urlCount` | URL Count | integer |
| `urls` | URLs | array |
| `capped` | Capped | boolean |
| `fetchedAt` | Fetched At | text |
| `engine` | Engine | text |
| `errorType` | Error Type | text |
| `errorMessage` | Error Message | text |

## Example response

Abridged: long text and lists are shortened.

```json theme={null}
{
  "job_id": "7f3a1c2e-0b9d-4c55-9a51-3f2e8d1b6a40",
  "agent": "web/map",
  "status": "completed",
  "row_count": 1,
  "truncated": false,
  "data": [
    {
      "site": "https://www.mindcase.co",
      "errorType": null,
      "errorMessage": null,
      "engine": "scan",
      "fetchedAt": "2026-11-09T10:25:33Z",
      "capped": false,
      "urlCount": 333,
      "urls": [
        {
          "url": "https://mindcase.co/",
          "lastModified": null,
          "source": "sitemap"
        },
        {
          "url": "https://mindcase.co/api",
          "lastModified": null,
          "source": "sitemap"
        }
      ],
      "domain": "mindcase.co"
    }
  ]
}
```

## Related APIs

For the page content of those URLs use [`web/crawl`](https://docs.mindcase.co/apis/web/crawl); for one page use [`web/scrape`](https://docs.mindcase.co/apis/web/scrape).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.