MarkUDown

Map API — MarkUDown website URL discovery API docs

POST/api/map

Map

Discover all URLs on a website via sitemap parsing and link crawling, without fetching page content. Fast and lightweight — great for planning a crawl or auditing site structure.

ParameterTypeRequiredDefaultDescription
urlarray<string>required—Root URL of the site to map, as a one-item array.
allowed_wordsarray<string>optional[]Only return URLs that contain at least one of these words.
blocked_wordsarray<string>optional[]Exclude URLs that contain any of these words.
max_urlsintegeroptional1000Maximum URLs to return.

Request

{
  "url": ["https://store.example.com"],
  "allowed_words": ["product"],
  "max_urls": 500
}

Response

// POST returns { "success": true, "id": "abc123", "url": "/api/map/abc123" }
// Poll GET /api/map/{id}
{
  "success": true,
  "id": "abc123",
  "status": "completed",
  "data": {
    "success": true,
    "total": 3,
    "links": [
      "https://store.example.com/product/shoes",
      "https://store.example.com/product/bag",
      "https://store.example.com/product/hat"
    ]
  }
}