Map

Discover URLs on a website via sitemaps and in-page link extraction.

Endpoint

POST /api/v1/map

Parameters

Parameter	Type	Default	Description
`url`	string	—	Required. Site URL to map
`search`	string	—	Filter discovered URLs by search query
`includeSubdomains`	boolean	`true`	Include subdomains in results
`limit`	integer	`5000`	Max URLs to return (max: 100,000)
`ignoreSitemap`	boolean	`false`	Skip sitemap.xml and only use in-page links

Examples

cURL

curl -X POST http://localhost:8080/api/v1/map \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "limit": 100
  }'

Python

import requests

response = requests.post("http://localhost:8080/api/v1/map", json={
    "url": "https://example.com",
    "limit": 100
})

data = response.json()
for link in data["links"]:
    print(link)

JavaScript

const response = await fetch("http://localhost:8080/api/v1/map", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    url: "https://example.com",
    limit: 100,
  }),
});

const data = await response.json();
data.links.forEach((link) => console.log(link));

Response

{
  "success": true,
  "links": [
    "https://example.com/",
    "https://example.com/about",
    "https://example.com/blog",
    "https://example.com/blog/post-1",
    "https://example.com/blog/post-2",
    "https://example.com/contact"
  ]
}

Filtering with Search

Use the search parameter to filter URLs by keyword:

curl -X POST http://localhost:8080/api/v1/map \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "search": "blog",
    "limit": 50
  }'

This returns only URLs containing "blog" in the path.

Map

On this page