Screenshot API Documentation

This API captures website screenshots similar to APIflash. Endpoint: /urltoimage (GET).

Usage example: http://your-server:8082/urltoimage?access_key=yourkey&url=https%3A%2F%2Fexample.com&width=1920&full_page=true

Parameters

ParameterTypeRequired / OptionalDefaultDescription
access_keystringrequired–Your API access key (set via env var ACCESS_KEY).
urlstringrequired–URL-encoded website URL (with http:// or https://).
formatstringoptionaljpegImage format: jpeg or png.
widthintegeroptional1440Viewport width in pixels (desktop view).
heightintegeroptional900Viewport height in pixels. Ignored if full_page=true.
full_pagebooleanoptionalfalseIf true, capture entire page (scrollable content).
qualityintegeroptional90Image quality (0-100) for jpeg format.
delayintegeroptional0Seconds to wait after page load before capture (0-10).
freshbooleanoptionalfalseIf true, disable cache for fresh load.
scale_factorintegeroptional1Device scale factor (1=standard, 2=retina).
transparentbooleanoptionalfalseEnable transparent background (png format only).
user_agentstringoptionalDefault browser UACustom User-Agent (URL-encoded).
wait_untilstringoptionaldomcontentloadedWait condition: domcontentloaded, load, networkidle0, networkidle2.
wait_imagesbooleanoptionalautoWait for visible images on Vucar auction pages. Set false for fastest capture.
image_timeoutintegeroptional10000Max milliseconds to wait for visible images (0-20000).
image_settleintegeroptional700Extra milliseconds to let late thumbnails paint after image wait (0-3000).
block_trackersbooleanoptionaltrueBlock analytics/tracker requests that slow screenshots.
accept_languagestringoptional–Accept-Language header (e.g., en-US).
cssstringoptional–Custom CSS to inject (URL-encoded).
jsstringoptional–Custom JS to execute before capture (URL-encoded).

Notes