---
title: "Map a Site's URLs"
method: POST
path: "/map"
tags: ["Map"]
---

# Map a Site's URLs

`POST /map`

## Request

- Base URL: `https://api.anakin.io/v1`
- URL: `https://api.anakin.io/v1/map`
- Auth: API key in header `X-API-Key`

Discover all reachable URLs under a given site — internal links, external links, and counts. Submit a URL to map. Returns a job ID — poll GET /map/{jobId} (with a delay in between) to fetch the completed link list.

## Request body

- MapRequest
  - `url` string, uri, required: The starting URL for discovery (typically a homepage or section root).
  - `limit` integer: Maximum number of URLs to return overall.
  - `depth` integer: How many link-hops from the starting URL to follow.
  - `limitPerLevel` integer: Maximum URLs collected per depth level (controls breadth).
  - `includeSubdomains` boolean: Include URLs on subdomains of the starting host.
  - `includeExternalLinks` boolean: Also collect (but do not follow) external links.
  - `useBrowser` boolean: Use a headless browser — best for JS-heavy sites.
  - `search` string: Optional keyword filter — only return URLs whose path/title matches.

## Response `202`

Job accepted

- MapSubmitResponse
  - `jobId` string: The job ID — pass to Get Map Result to poll for completion.
  - `status` 'pending' | 'processing'

## Other responses

- `400`: Bad request — missing or malformed body
- `401`: Missing or invalid API key

---

[API](https://skmtc.dev/anakin/apis/anakin-api.md) · [All operations](https://skmtc.dev/anakin/apis/anakin-api/llms.txt) · [OpenAPI document](https://skmtc.dev/anakin/apis/anakin-api/revisions/5eda91e679e5?raw)