For usage in Javascript (either Node.js or in browser), see our Javascript API.
Screenshot modifier options are placed before the requested URL. See below for a full list of options.
| Param | Type | Description |
|---|---|---|
width/[val]/ |
Number |
Thumbnail width in pixels
(Default: 600 (1/2 of the viewportWidth))
|
crop/[val]/ |
Number |
Height of original screenshot in pixels
(Default: 1200)
|
maxAge/[val]/ |
Number | Refresh the thumbnail if the cached image is older than this amount, in hours |
allowJPG/ |
Return a JPG instead of PNG format when possible. JPG images are smaller but are not as high quality. (Recommended for thumbnails and smaller, particularly when a large number of screenshots are embeded on a single page.) | |
noanimate/ |
Don't animate the resulting image, just return the final png. (Good for batch jobs that download images.) | |
fullpage/ |
Return an image containing the full page, not just the visible area. (Only available to "better" plan users. These requests will not display a loading spinner but instead will block until the final png is ready.) | |
wait/[val]/ |
Wait for the specified number of seconds after the webpage has loaded before taking a screen shot. This is useful for pages that have animations or other ajax based components that load asyncrhonously. (Only available to "better" plan users.) | |
viewportWidth/[val]/ |
Set the viewportWidth of the browser. Maximum value is 1200.
(Only available to "better" plan users)
(Default: 1200)
|
|
iphone5/ |
Emulate an iPhone 5. (Only available to "better" plan users.) | |
iphone6/ |
Emulate an iPhone 6. (Only available to "better" plan users.) | |
iphone6plus/ |
Emulate an iPhone 6 Plus. (Only available to "better" plan users.) | |
galaxys5/ |
Emulate a Galaxy S5. (Only available to "better" plan users.) |
width/[val]/
(Number)
Thumbnail width in pixels
(Default: 600 (1/2 of the viewportWidth))
|
crop/[val]/
(Number)
Height of original screenshot in pixels
(Default: 1200)
|
maxAge/[val]/
(Number)
Refresh the thumbnail if the cached image is older than this amount, in hours
|
allowJPG/
Return a JPG instead of PNG format when possible. JPG
images are smaller but are not as high quality.
(Recommended for thumbnails and smaller, particularly when a large number of screenshots are
embeded on a single page.)
|
noanimate/
Don't animate the resulting image, just return the final png.
(Good for batch jobs that download images.)
|
fullpage/
Return an image containing the full page, not just the visible area.
(Only available to "better" plan users. These requests will not display a
loading spinner but instead will block until the final png is ready.)
|
wait/[val]/
Wait for the specified number of seconds after the webpage
has loaded before taking a screen shot. This is useful for pages that have
animations or other ajax based components that load asyncrhonously.
(Only available to "better" plan users.)
|
viewportWidth/[val]/
Set the viewportWidth of the browser. Maximum value is 1200.
(Only available to "better" plan users)
(Default: 1200)
|
iphone5/
Emulate an iPhone 5.
(Only available to "better" plan users.)
|
iphone6/
Emulate an iPhone 6.
(Only available to "better" plan users.)
|
iphone6plus/
Emulate an iPhone 6 Plus.
(Only available to "better" plan users.)
|
galaxys5/
Emulate a Galaxy S5.
(Only available to "better" plan users.)
|
/image/ to the begining of the URL to let our
system know that your are requesting an image rather than a screenshot.
| Param | Type | Description |
|---|---|---|
image/width/[width]/ |
Number | Resize the image to [width] pixels wide (preserve aspect-ration) |
image/fit/[width]x[height]/ |
Dimensions | Resize and crop the image so that it completely fills an image that is width x height |
image/width/[width]/
(Number)
Resize the image to [width] pixels wide (preserve aspect-ration)
|
image/fit/[width]x[height]/
(Dimensions)
Resize and crop the image so that it completely fills an image that is width x height
|