Map

Map a Site's URLs

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.

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

Request body

urlstring uri required

The starting URL for discovery (typically a homepage or section root).

limitinteger

Maximum number of URLs to return overall.

depthinteger

How many link-hops from the starting URL to follow.

limitPerLevelinteger

Maximum URLs collected per depth level (controls breadth).

includeSubdomainsboolean

Include URLs on subdomains of the starting host.

includeExternalLinksboolean

Also collect (but do not follow) external links.

useBrowserboolean

Use a headless browser — best for JS-heavy sites.

searchstring

Optional keyword filter — only return URLs whose path/title matches.

Example request

{
  "url": "https://example.com"
}

Response

Job accepted

jobIdstring

The job ID — pass to Get Map Result to poll for completion.

status'pending' | 'processing'

Changes

No recorded changes to this operation across all 1 revision of this API.