Website Screenshot
Turn any public URL into a PNG, JPEG, WebP, or PDF asset rendered by BrowserSolver. No local Chromium fleet to operate.
Credit cost: 2 credits per call
ApiKeyAuthx-api-key<token>Your API key. Include it in the x-api-key header for every request.
url*stringPage address to render into an image or PDF. Must include a protocol.
Sample targets:
https://www.amazon.com/s?k=pokemonhttps://www.cdiscount.com/sante-mieux-vivre/materiel-medical/soin-domicile/l-1650608.htmlhttps://github.com/seaweedfs/seaweedfsformat?stringFile type returned in the response body.
Choose one of:
webpjpeg
jpgpngpdf"png""jpeg""jpg""pdf""png""webp"device?stringSwap the desktop viewport for a preset handset or tablet fingerprint.
Presets:
iphone_14_pro_maxiphone_14_proiphone_13_pro_maxiphone_13_miniiphone_12iphone_xipadgalaxy_s23_ultragalaxy_s23galaxy_s8galaxy_fold4pixel_7_propixel_6apixel_5redmi_note_12_pro
redmi_note_11huawei_p60_prohuawei_mate_50_pro"galaxy_fold4""galaxy_s23""galaxy_s23_ultra""galaxy_s8""huawei_mate_50_pro""huawei_p60_pro""ipad""iphone_12""iphone_13_mini""iphone_13_pro_max""iphone_14_pro""iphone_14_pro_max""iphone_x""pixel_5""pixel_6a""pixel_7_pro""redmi_note_11""redmi_note_12_pro"full_page?booleanExtend the capture beyond the viewport so the entire scrollable document is included.
falsefull_page_scroll?booleanDrive a scroll pass first so deferred content mounts before a tall capture.
falsefull_page_scroll_duration?numberMilliseconds spent scrolling prior to a full-height capture.
"400"viewport_width?numberWidth of the synthetic desktop window, in pixels.
"1280"viewport_height?numberHeight of the synthetic desktop window, in pixels.
"1024"scale_factor?numberPixel density multiplier. Raise it for retina-quality output; files grow accordingly.
"1"image_quality?stringLossy compression level for soft formats.
Applies when format is:
jpegwebp"80"selector?stringLimit the shot to one DOM node matched by this CSS selector.
cache?booleanServe a stored capture on repeat requests when caching is enabled.
falsecache_ttl?numberLifetime of cached captures in seconds.
3600 <= value <= 2592000"2592000"remove_selectors?stringHide matching CSS selectors (modals, promo bars, etc.) before shooting.
remove_ads?booleanBest-effort stripping of ad slots before capture.
falseblock_resources?stringResource kinds to discard during load, as a comma list (example: image,stylesheet,font).
Kinds:
documentstylesheetimagemediafontscripttexttrackxhrfetcheventsourcewebsocketmanifestotherHelps shorten load time on media-heavy pages.
"document""eventsource""fetch""font""image""manifest""media""other""script""stylesheet""texttrack""websocket""xhr"block_urls?stringSubstring patterns that should never be fetched (example: analytics,tracking,advertisement). Hosts, paths, or fragments such as .example.com/ work.
delay?numberAdditional settle time in seconds after the readiness event.
0 <= value <= 10"0"wait_until?array<string>Which browser lifecycle event marks the page ready.
Values:
networkidle2loaddomcontentloadednetworkidle0
"domcontentloaded""load""networkidle0""networkidle2"wait_for_selector?stringHold capture until this CSS node is present.
proxy?stringRoute the browser through an intermediate proxy.
Protocols: HTTP, HTTPS, SOCKS5.
Shape: http://username:password@proxy.com:PORT.
Handy for region-specific views or IP rotation.
s3_secret_key?stringSecret key used to authenticate uploads.
s3_access_key_id?stringAccess key used to authenticate uploads.
s3_bucket?stringDestination bucket for the binary asset.
s3_object_key?stringKey under which the object is stored (generated automatically if blank).
s3_region?stringCloud region of the bucket.
storage_endpoint?stringOverride the default AWS endpoint for S3-compatible backends. Leave blank for AWS. R2 example: https://<accountId>.r2.cloudflarestorage.com.
s3_url?booleanUpload the binary and include the public object URL in the API response.
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}.
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
falseSuccessful response
response?filebinarycurl -X GET 'https://api.browsersolver.com/v1/website/screenshot?url=string'"string"