CaptureKit

Website Crawler

GET
/v1/website/crawler

Website Crawler API fetches raw HTML from any webpage in request mode (no rendering) for fast scraping, audits, monitoring, and link/metadata extraction.

Credit cost: 1 credit per call

Authorization

ApiKeyAuth
x-api-key<token>

Your API key. Include it in the x-api-key header for every request.

In: header

Query Parameters

query*string

A website URL with either the http or https protocol.

allow_redirects?boolean

If set to false, do not follow redirects.

Default"true"
return_page_source?boolean

If set to true, the response will be the HTML source of the page.

Default"false"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/website/crawler?query=string"
Empty
{  "error": "Bad Request"}
{  "error": "Invalid API Key"}
{  "error": "Payment required"}
{  "error": "Rate limit exceeded for the API key: quota monthly"}
{  "error": "Internal Error"}