Skip to main content
GET
https://api.scriptbase.app
/
api
/
v1
/
scrape
/
map
curl "https://api.scriptbase.app/api/v1/scrape/map?url=https://example.com" \
  -H "X-API-Key: sk_your_key_here"

{
  "success": true,
  "data": {
    "urls": [
      "https://example.com/",
      "https://example.com/about",
      "https://example.com/contact",
      "https://example.com/products",
      "https://example.com/blog"
    ],
    "count": 5
  },
  "meta": {
    "creditsUsed": 5,
    "creditsRemaining": 995,
    "rateLimit": {
      "limit": 60,
      "remaining": 59,
      "resetAt": 1704326400
    }
  }
}

​
Overview

Map all discoverable URLs on a website. Useful for planning crawls, understanding site structure, or building sitemaps.

​
Authentication

​
X-API-Key
string
required
Your API key

​
Query Parameters

​
url
string
required
Website URL to map (must be a valid HTTP/HTTPS URL)

​
Credits

  • Cost: 5 credits per request

​
Response

​
success
boolean
Whether the request was successful
​
data
object
​
meta
object
curl "https://api.scriptbase.app/api/v1/scrape/map?url=https://example.com" \
  -H "X-API-Key: sk_your_key_here"

{
  "success": true,
  "data": {
    "urls": [
      "https://example.com/",
      "https://example.com/about",
      "https://example.com/contact",
      "https://example.com/products",
      "https://example.com/blog"
    ],
    "count": 5
  },
  "meta": {
    "creditsUsed": 5,
    "creditsRemaining": 995,
    "rateLimit": {
      "limit": 60,
      "remaining": 59,
      "resetAt": 1704326400
    }
  }
}

​
Error Codes

StatusCodeDescription
400INVALID_INPUTInvalid or missing URL parameter
401INVALID_API_KEYAPI key is missing or invalid
422SCRAPE_FAILEDFailed to map the URL
429QUOTA_EXCEEDEDMonthly quota exhausted
429RATE_LIMIT_EXCEEDEDToo many requests
  • Only same-domain URLs are returned.
  • External links are not included in the map.
  • Use this endpoint before Crawl Website to plan your crawl.