Website Crawler
GET
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
ApiKeyAuthheader
x-api-key<token>Your API key. Include it in the x-api-key header for every request.
query*stringA website URL with either the http or https protocol.
allow_redirects?booleanIf set to false, do not follow redirects.
Default
truereturn_page_source?booleanIf set to true, the response will be the HTML source of the page.
Default
falsefields?stringComma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).
is_async?booleanRun the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.
Default
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
Default
falseSuccessful response
response?unknown*/*curl -X GET 'https://api.capturekit.dev/v1/website/crawler?query=string'Example Response
null