Screenshot

Capture Screenshot

Capture screenshot

GET https://api.microshot.io/v1/screenshot

Captures a new screenshot

Query Parameters

Name	Type	Description
url*	string	The URL of the website for which you want to capture a screenshot. It should be URL encoded and must include the protocol (http:// or https://) to be processed correctly.
format	string	Defines the image format to be used. One of png, jpeg, webp. Defaults to jpeg
quality	integer	The quality of the image between 0 and 100. Works only with the jpeg and webp formats. Defaults to 80
disable_ads	bool	Prevent ads from being displayed on the captured screenshot. Block requests from popular ad-networks. Defaults to false
full_page	bool	It captures a full scrollable page screenshot. Defaults to false
response_type	bool	The type of response to return. Can be either image or json. When the json type is used, the JSON response with the link to the screenshot hosted on our CDN is returned. When the image type is used, the binary image is returned. Defaults to image
width	integer	The width of the viewport to use (in pixels). Defaults to 1920
height	integer	The height of the viewport to use (in pixels). Defaults to 1080
hide_cookie_banners	bool	Prevent cookie banners and popups from being displayed. Defaults to false
animations	bool	Enables/disables CSS animations and transitions. Defaults to true

500: Internal Server Error Unable to capture the screenshot.

{
    message: "Unreachable host."
}

429: Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests

{
    // Response
}

422: Unprocessable Entity Invalid arguments

{
    message: "Invalid arguments",
    errors: {
        url: [
            "The URL should be provided."
        ]
    }
}

200: OK Screenshot successfully captured

{
    url: "https://cdn.microshot.io/XC31L2VqiGPO3SGGBSjJ-mgqa9SDX8fiWm0Wmyi5MrYFtuW5ubyl0vPxGD11m2lHusOGJEZOIc5xmk-w.jpeg"
}

401: Unauthorized Invalid or revoked API key

{
    type: "https://tools.ietf.org/html/rfc2616#section-10",
    title: "An error occurred",
    status: 401,
    detail: "Unauthorized"
}