Skip to main content
GET
/
shot
Get a screenshot
curl --request GET \
  --url https://api.example.com/shot
"File"

Query Parameters

​
key
string
required

Your API key

​
url
string
required

The URL to take a screenshot of

​
cacheKey
string

Custom cache key. If not provided, defaults to hash of request method and URL

​
fresh
boolean
default:false
​
format
enum<string>
default:png
Available options:
png,
jpeg,
webp
​
quality
number
default:100
​
fullPage
boolean
default:false
​
viewportType
enum<string>
default:desktop
Available options:
mobile,
tablet,
desktop,
custom
​
width
number
default:1920

Only used when viewportType is custom

​
height
number
default:1080

Only used when viewportType is custom

​
deviceScaleFactor
number
default:1

Only used when viewportType is custom

​
blockAds
boolean
default:false
​
blockBanners
boolean
default:false
​
blockTracking
boolean
default:false
​
waitUntil
enum<string>
default:networkidle2
Available options:
load,
domcontentloaded,
networkidle0,
networkidle2
​
timeout
number
default:30000
​
customCookies
string
​
customHeaders
string
​
background
string
​
backgroundPadding
number
​
backgroundBorderRadius
number
​
customUserAgent
object

Response

Response for status 200

The response is of type file.