API Reference

Web Map

Retrieve all accessible links and URLs from a website by parsing its sitemap.xml or crawling the link structure. Useful for discovering all pages before a targeted scrape.

GET/v1/web/map•1 credit

Parameters

Name	Type	Required	Default	Description
`url`	`string`	required	—	Root URL of the website to map

Code Examples

from supacrawlx import Client

client = Client("YOUR_API_KEY")
result = client.web.map("https://example.com")
for url in result.links:
    print(url)

Response

JSON

{
  "url": "https://example.com",
  "links": [
    "https://example.com/",
    "https://example.com/about",
    "https://example.com/pricing",
    "https://example.com/blog",
    "https://example.com/blog/post-1"
  ],
  "count": 5,
  "creditsUsed": 1
}