Screenshot

Capture full-page or element-level screenshots of any webpage. Handles JavaScript rendering, anti-bot protection, and dynamic content automatically. Returns a public image URL.

POST/v1/screenshot

Capture a screenshot of a webpage. Supports full-page capture, element-specific capture, custom viewport sizes, and browser actions before capture.

Request Body

Parameter	Type	Description
`url`required	string	URL to capture
`fullPage`	boolean	Capture full scrollable page. Defaults to true
`selector`	string	CSS selector to capture a specific element
`width`	number	Viewport width (320-3840). Defaults to 1920
`height`	number	Viewport height (240-2160). Defaults to 1080
`waitFor`	number	Extra wait time in ms after page load
`actions`	Action[]	Browser actions to execute before capture
`proxy`	{ country: string }	Geo-targeted proxy by country code

Example Request

cURL

Node.js

curl -X POST https://api.builde2e.com/api/v1/screenshot \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer uc-YOUR-API-KEY' \
  -d '{
    "url": "https://example.com",
    "fullPage": true,
    "width": 1920,
    "height": 1080
  }'

Example Response

json

{
  "success": true,
  "url": "https://storage.builde2e.com/screenshots/1706745600000-screenshot.png",
  "sourceUrl": "https://example.com",
  "width": 1920,
  "height": 4320,
  "timestamp": "2025-02-03T10:15:30.123Z",
  "cost": 0.003
}

Response Fields

Field	Type	Description
`success`	boolean	Whether the screenshot was successful
`url`	string	Public URL of the captured screenshot image
`sourceUrl`	string	The original URL that was captured
`width`	number	Width of the captured image in pixels
`height`	number	Height of the captured image in pixels
`cost`	number	Cost of the request in USD
`error`	string	Error message if screenshot failed
`timestamp`	string	ISO timestamp when capture completed

Element Screenshot

Use the selector parameter to capture a specific element on the page instead of the full viewport.

Node.js

const result = await BuildE2E.screenshot({
  url: 'https://example.com/dashboard',
  selector: '.chart-container',
  width: 1280,
  height: 720
});

Screenshot with Actions

Execute browser actions before taking the screenshot. Useful for toggling UI states, dismissing modals, scrolling to specific content, or interacting with the page before capture.

Node.js

const result = await BuildE2E.screenshot({
  url: 'https://example.com/app',
  actions: [
    { type: 'click', selector: '#dark-mode-toggle' },
    { type: 'wait', milliseconds: 500 },
    { type: 'scroll', direction: 'down' }
  ],
  fullPage: false,
  width: 1440,
  height: 900
});

Pricing

Flat per-screenshot pricing. The cost is returned in each response.

Operation	Cost (USD)	Description
Screenshot	`$0.003 per screenshot`	Flat rate per capture (~$3.00 per 1000)