Skip to content

Options

fullPage

Capture the whole scrollable page instead of just the viewport.

Type
boolean
Default
false
Group
Output
On this page

OverviewLink to this section

Captures everything the page scrolls to, from the very top to the very bottom, instead of only the part that fits in the browser window. The image is as wide as width and as tall as the page itself.

Before every capture the page is scrolled from top to bottom, so lazy loaded images and videos below the fold are already there when the full page is taken.

ExampleLink to this section

The same request with the SDK, with cURL and as the raw JSON body.

screenshot.ts
import { Url2Image } from '@url2image/sdk'

const { success, data, message } = await Url2Image({
    url: 'https://example.com',
    token: process.env.URL2IMAGE_TOKEN,
    options: {
        fullPage: true
    }
})

Good to knowLink to this section

Every option, grouped, is in the options overview.

Something unclear or missing on this page?

Tell us