arrow_back All endpoints

Website Screenshot

POST/api/v1/tools/website-screenshot25 credits per callscreenshotwebsiteurlcapturebrowserrender

Loads a public URL in a real browser at the viewport you choose, waits for web fonts and the network to settle, then captures the visible area or the whole scrolling page. Requests to private or link-local addresses are refused, and ad/tracker hosts can be dropped before they render.

receipt_long
Why 25 credits?

Every call starts and tears down a headless Chromium instance, which is an order of magnitude heavier than an HTTP fetch.

Any HTTP client works. Replace the key with one from your dashboard.

bash
curl -X POST https://toolkitbackend-j69m.onrender.com/api/v1/tools/website-screenshot \
  -H "Authorization: Bearer tb_live_<your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "width": 1440,
  "height": 900,
  "fullPage": true,
  "deviceScaleFactor": 1,
  "format": "png",
  "quality": 85,
  "blockAds": true,
  "hideOverlays": false
}'

Input

FieldTypeRequiredDefaultDescription
urlstringrequired- Public http(s) address to capture.
widthintegeroptional1440 Viewport width in CSS pixels. The page lays itself out at this width, so responsive breakpoints apply.
heightintegeroptional900 Viewport height in CSS pixels. Ignored when fullPage is true.
fullPagebooleanoptionalfalse Capture the entire scrollable page. Scrolls first so lazy-loaded images are present.
deviceScaleFactorintegeroptional1 1 for standard density, 2 for a Retina capture.
formatstringoptionalpng png or jpeg. Defaults to png.
qualityintegeroptional85 JPEG quality, 40-100. Ignored for png.
blockAdsbooleanoptionaltrue Drop known ad and tracker hosts before they render.
hideOverlaysbooleanoptionalfalse Remove cookie banners, newsletter modals and large sticky panels after load.

Output

FieldTypeDescription
fileBase64stringCaptured image, base64-encoded, without a data URI prefix.
mimeTypestringimage/png or image/jpeg.
widthintegerPixel width of the returned image.
heightintegerPixel height of the returned image.
pageTitlestringDocument title, useful as a filename.
finalUrlstringAddress after any redirects.
truncatedbooleanTrue when a very tall page was clipped to the height ceiling.
blockedRequestCountintegerRequests dropped as ads, trackers or private-network targets.

Try it

Sends a real POST /api/v1/tools/website-screenshot from your browser and charges 25 credits to your account.

Sign in to run this endpoint. New accounts start with free credits.