Skip to main content
POST
/
web
/
map
curl -X POST https://scrape.st/web/map \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "limit": 100
  }'

{
  "map_id": "map_01HZX...",
  "version": "1.0.0",
  "status": "completed",
  "url": "https://example.com",
  "data": {
    "links": ["https://example.com/", "https://example.com/about"],
    "total_links": 2
  }
}
Map a website and return the links discovered on it. Useful for building a crawl plan or auditing site structure. Runs synchronously.

​
Request Body

​
url
string
required
The site URL to map.
​
filter
string
Only return links containing this substring.
​
limit
number
default:"5000"
Maximum number of links to return. Between 1 and 100000.
​
include_subdomains
boolean
default:"true"
Include links on subdomains of the target site.
​
ignore_query_parameters
boolean
default:"true"
Treat URLs that differ only by query string as the same link.
​
timeout
number
Max time in milliseconds to wait. Between 1000 and 600000.

​
Response

​
data
object
links (string[]) — discovered URLs; total_links (number) — count.
curl -X POST https://scrape.st/web/map \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "limit": 100
  }'

{
  "map_id": "map_01HZX...",
  "version": "1.0.0",
  "status": "completed",
  "url": "https://example.com",
  "data": {
    "links": ["https://example.com/", "https://example.com/about"],
    "total_links": 2
  }
}