Fullpage Parameter

The fullpage parameter allows you to capture the entire page height, regardless of the viewport height setting.

Specifications

PropertyValue
Typeboolean
RequiredNo
Defaultfalse
APIBoth HTML/CSS and Screenshot APIs

Description

When fullpage is set to true:

  • The entire page height will be captured
  • The viewport width will still be respected
  • Scrollable content will be included in the capture
  • The final image height will match the content height

For pages with dynamic content or infinite scroll, we recommend setting a reasonable max-height on your content to prevent timeouts.

When setting fullpage to true the DPI value will be forced to 1. If you need a larger DPI then use set dimensions.

Examples

Basic Fullpage Screenshot

{
    "url": "https://example.com",
    "fullpage": true
}

HTML with Long Content

{
    "html": "<div style='height: 2000px'>Long scrolling content</div>",
    "fullpage": true,
    "width": 1440
}

Combining with Webhook

{
    "url": "https://example.com",
    "fullpage": true,
    "webhook_url": "https://your-domain.com/webhook"
}

Full page captures may take longer to process, especially for long pages. We recommend using the webhook_url parameter for these requests.

Common Use Cases

  1. Landing Page Captures
  • Capture entire marketing pages
  • Include all sections in one image
  1. Content Archives
  • Save full articles or blog posts
  • Archive entire web pages
  1. Portfolio Screenshots
  • Capture entire project pages
  • Show full design implementations

Use CSS to set a max-height on infinite scroll containers or dynamic content so captures stay predictable.

Common values

  • true - capture the entire scroll height. Use with webhook_url for long pages.
  • false (default) - capture only the visible viewport defined by width and height.

When to use

Use fullpage: true when you want every section of a page in one image, like a landing page archive or a portfolio screenshot. Use the default for fixed-size outputs like OG images, social cards or product cards where the dimensions are part of the spec.

Common mistakes

  • Pairing with high DPI. When fullpage is true, DPI is forced to 1. Set explicit width and height if you need higher DPI.
  • Capturing infinite-scroll pages. Pages that lazy-load forever will time out. Inject CSS to set a max-height on scroll containers or capture a specific section with selector.

See also: getting started guide, webhook_url.