Take Endpoint

On this page, we’ll dive into the take endpoint you can use to render a website.


GET/v1/take

Render a Website

This endpoint lets you render a website.

Required attributes

  • Name
    url
    Type
    string
    Description

    The URL of the website you want to render.

Optional attributes

  • Name
    format
    Type
    string
    Description

    The format of the image returned. Supported: jpg, jpeg, png, gif

  • Name
    quality
    Type
    integer
    Description

    The quality of the image returned. Only supported when the format is jpg or jpeg

  • Name
    full_page
    Type
    boolean
    Description

    To take the screenshot of the full page, set full_page=1. Default value is 0.

  • Name
    viewport_width
    Type
    integer
    Description

    The width of the browser viewport in pixels. The browser’s viewport is the window area where you can see the website. Default value is 1280.

  • Name
    viewport_height
    Type
    integer
    Description

    The height of the browser viewport in pixels. The browser’s viewport is the window area where you can see the website. Default value is 800.

Request

GET
/v1/take
curl -G https://api.screenshotbase.com/v1/take?url=https%3A%2F%2Fbbc.com \
    -H "apikey: YOUR-API-KEY"