ScreenShot API#



Get Screenshot of any webpage from the given URL as input

Input Params#

Parameter Type Requirement Explanation
URL string required Any valid URL which is publicaly accessible over the Internet.
Viewport string required The viewing area of the browser which is making the screenshot request.
Fullpage boolean Optional By default screenshots are only of the visible 'above the fold' area of the viewport. If Fullpage is specified, the resulting screenshot will include the entire page, scrolled down to the bottom.
Javascript boolean Optional By default, Javascript is enabled. To disable Javascript while capturing the screenshot, set this to false. This can be useful to prevent pop up banners from covering portions of the page you wish to capture, however some sites will not render properly without Javascript.
Webdriver string required Specify the web driver (web browser) to use for the capture. Options are firefox (default) chrome phantomjs

Response Params#

Parameter Type Explanation
status string Status of API, ready or error
imageUrl string URL of the captured screenshot

curl -H "Authorization: {api_key}" ""

Example Requests#

POST curl -H "Authorization: {api_key}" -L "{{url}}"

Example Response#


Error Handling#

HTTP response codes to indicate the success or failure of an API request.

Code Status Explanation
200 OK Successful request.
400 Bad Request Invalid request, or invalid parameters .
403 Authentication Not authorized.
404 Not Found The resource requested was not found.
5xx Server Error A fatal error occurred while processing the request. Try again.

All errors will be JSON object with a String array of errors:

  "errors": ["Malformed request"]

Plans Description#

Plan API Calls Price
Basic 10000 $5/Month Get this
Starter 30000 $10/Month Get this
Professional 50000 $15/Month Get this
Professional Plus 100000 $50/Month Get this

Try Now#

Input Params



↑ Was this documentation useful? Yes No

Ready to Get Started?#

Get API Key