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

Autorisierung

ApiKeyAuth
headerx-api-key<token>

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

Abfrageparameter

query*string

A website URL with either the http or https protocol.

allow_redirects?boolean

If set to false, do not follow redirects.

Defaulttrue
return_page_source?boolean

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

Defaultfalse
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Antworttext

Successful response

response?unknown*/*
Example Request
curl -X GET 'https://api.capturekit.dev/v1/website/crawler?query=string'
Example Response
null