Skip to main content
GET
https://api.scriptbase.app
/
api
/
v1
/
scrape
curl "https://api.scriptbase.app/api/v1/scrape?url=https://example.com" \
  -H "X-API-Key: sk_your_key_here"
{
  "success": true,
  "data": {
    "url": "https://example.com",
    "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission.\n\n[More information...](https://www.iana.org/domains/example)",
    "title": "Example Domain",
    "description": "Example description for the page",
    "ogImage": null,
    "characterCount": 245,
    "extractedUrls": [
      "https://www.iana.org/domains/example"
    ]
  },
  "meta": {
    "creditsUsed": 5,
    "creditsRemaining": 995,
    "rateLimit": {
      "limit": 60,
      "remaining": 59,
      "resetAt": 1704326400
    }
  }
}

Overview

Convert any website to clean, structured markdown format. The scraper automatically extracts main content and removes navigation, ads, and boilerplate.

Authentication

X-API-Key
string
required
Your API key

Query Parameters

url
string
required
The URL to scrape (must be a valid HTTP/HTTPS URL)
Remove hyperlinks from the output
includeTables
boolean
default:"true"
Include HTML tables in the markdown output
includeImages
boolean
default:"true"
Include image URLs in the markdown output
lang
string
Language hint for better parsing (ISO 639-1)

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?url=https://example.com" \
  -H "X-API-Key: sk_your_key_here"
{
  "success": true,
  "data": {
    "url": "https://example.com",
    "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission.\n\n[More information...](https://www.iana.org/domains/example)",
    "title": "Example Domain",
    "description": "Example description for the page",
    "ogImage": null,
    "characterCount": 245,
    "extractedUrls": [
      "https://www.iana.org/domains/example"
    ]
  },
  "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 fetch or parse the URL
429QUOTA_EXCEEDEDMonthly quota exhausted
429RATE_LIMIT_EXCEEDEDToo many requests
  • The scraper respects robots.txt and rate limits.
  • Some websites may block scraping attempts.
  • JavaScript-rendered content may not be fully captured.
  • Maximum content size is 10MB per page.