{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full-Page PNG, JPEG & PDF", "description": "Screenshot web pages from a list of URLs as PNG, JPEG or PDF. Use when you need an image of a public page. Input: urls, optional format, fullPage, device, darkMode. Output per URL: screenshot file URL, final URL, HTTP status, title, size. Cookie banners hidden; failed pages not charged.", "version": "0.1", "x-build-id": "jlvn8bl8K7fGSKhHY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/phaux~website-screenshots/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-phaux-website-screenshots", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/phaux~website-screenshots/runs": { "post": { "operationId": "runs-sync-phaux-website-screenshots", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/phaux~website-screenshots/run-sync": { "post": { "operationId": "run-sync-phaux-website-screenshots", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Public web pages to capture (http/https). Duplicates are removed. No login or credentials are supported. Example: [\"https://apify.com\", \"https://en.wikipedia.org/wiki/Web_scraping\"].", "items": { "type": "string" } }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "Image (PNG/JPEG) or a PDF of the page. Default: \"png\".", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page. Off = only the visible viewport. Default: true.", "default": true }, "maxHeight": { "title": "Max height (px)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Crop full-page captures to this height from the top, in pixels. Default 10,000 px; raise it up to 20,000 px (hard cap). 0 = up to the 20,000 px cap. When a page is cut, truncatedAtPx in the output says where.", "default": 10000 }, "viewportWidth": { "title": "Viewport width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Browser window width in CSS pixels (ignored when a device is chosen). Default: 1280.", "default": 1280 }, "viewportHeight": { "title": "Viewport height", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Browser window height; this is the image height when Full page is off. Default: 800.", "default": 800 }, "deviceScaleFactor": { "title": "Pixel ratio", "enum": [ "1", "2", "3" ], "type": "string", "description": "Device pixel ratio (ignored when a device is chosen). Default: \"1\".", "default": "1" }, "device": { "title": "Device emulation", "enum": [ "", "iPhone 15 Pro", "iPhone 15 Pro Max", "iPhone 14", "Pixel 7", "Pixel 5", "Galaxy S9+", "iPad Pro 11", "iPad Mini", "Galaxy Tab S9", "Desktop Chrome", "Desktop Chrome HiDPI", "Desktop Safari" ], "type": "string", "description": "Emulate a phone/tablet: its viewport, pixel ratio, touch and user agent. Default: empty.", "default": "" }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark colour scheme (prefers-color-scheme: dark). Default: false.", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common consent pop-ups (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics, Sourcepoint and generic cookie bars). Nothing is clicked or accepted. Default: true.", "default": true }, "blockAds": { "title": "Block ads", "type": "boolean", "description": "Block requests to common ad/tracking networks for cleaner, faster captures. Default: true.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Navigation event to wait for before the steps below. Default: \"load\".", "default": "load" }, "waitForNetworkIdleMs": { "title": "Extra wait for network idle (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait up to this long for network requests to settle (prevents half-loaded screenshots). It never fails the capture. Default: 3000.", "default": 3000 }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "CSS selector that must be visible before capturing, e.g. '#main' or '.product-grid'." }, "waitForSelectorTimeoutSecs": { "title": "Selector timeout (s)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Fail (not charged) if the selector does not appear in time. Default: 10.", "default": 10 }, "delayMs": { "title": "Delay before capture (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Fixed delay right before the capture, for animations. Default: 500.", "default": 500 }, "scrollToLoadLazyContent": { "title": "Scroll to load lazy images", "type": "boolean", "description": "For full-page captures, scroll down quickly (time-capped) to trigger lazy loading, then scroll back to the top. Default: true.", "default": true }, "maxScrollMs": { "title": "Max scrolling time (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Hard cap on scrolling time so long/infinite pages stay fast. Default: 4000.", "default": 4000 }, "stickyElements": { "title": "Sticky headers", "enum": [ "unstick", "hide", "keep" ], "type": "string", "description": "How fixed/sticky headers and widgets are handled in full-page captures. Default: \"unstick\".", "default": "unstick" }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "CSS selectors to hide before capturing (chat widgets, banners, ...). Example: [\"#newsletter-popup\", \".chat-widget\"].", "items": { "type": "string" } }, "elementSelector": { "title": "Capture one element", "type": "string", "description": "CSS selector; capture only the first matching element. Example: \"main\"." }, "clip": { "title": "Capture a region", "type": "object", "description": "Region in page pixels: {\"x\":0,\"y\":0,\"width\":1280,\"height\":600}." }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPEG compression quality from 1 (smallest file) to 100 (best quality). Used only when format is jpeg. Default: 80.", "default": 80 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "Tabloid" ], "type": "string", "description": "Paper size of the PDF. Used only when format is pdf. Default: \"A4\".", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Print the PDF in landscape orientation. Used only when format is pdf. Default: false.", "default": false }, "pdfPrintBackground": { "title": "PDF backgrounds", "type": "boolean", "description": "Include background colours/images in PDFs. Default: true.", "default": true }, "visualDiff": { "title": "Visual diff: compare with the previous screenshot", "type": "boolean", "description": "Off by default. When on, each new PNG/JPEG screenshot is compared with a baseline: the previous screenshot of the same URL and settings (kept in a key-value store in your account), or the image URL you give below. Each item gets 'visualDiff' with percentChanged, the changed area and a diff image link (changed pixels in red). No extra charge: you pay per screenshot as usual.", "default": false }, "baselineStoreName": { "title": "Baseline store name", "type": "string", "description": "Named key-value store in YOUR Apify account that keeps the last screenshot per URL and settings. The first run with a new store has nothing to compare (status 'no_baseline') and only saves baselines. Use different names for separate monitors. Letters, digits and '-' only. Example: \"website-screenshots-baselines\". Default: \"website-screenshots-baselines\".", "default": "website-screenshots-baselines" }, "baselineImageUrls": { "title": "Baseline image URLs (optional)", "type": "array", "description": "Optional. Public PNG/JPEG URLs to compare against instead of the stored baseline, in the same order as the URLs above (line 1 is the baseline for URL 1, and so on; leave a line out to use the stored baseline). For example, a screenshotUrl from an earlier run.", "items": { "type": "string" } }, "updateBaseline": { "title": "Save this screenshot as the new baseline", "type": "boolean", "description": "On (default): after comparing, each new screenshot replaces the stored baseline, so the next run shows changes since this run. Off: keep the old baseline (compare every run with a fixed reference).", "default": true }, "diffPixelTolerance": { "title": "Pixel tolerance (0-255)", "minimum": 0, "maximum": 255, "type": "integer", "description": "A pixel counts as changed when a colour channel differs by more than this. 32 ignores anti-aliasing and JPEG noise; 0 counts every tiny change. Default: 32.", "default": 32 }, "failOnHttpError": { "title": "Treat HTTP 4xx/5xx as failure", "type": "boolean", "description": "On: error pages are not captured and not charged. Off: capture them anyway. Default: true.", "default": true }, "navigationTimeoutSecs": { "title": "Page load timeout (s)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for the page to load on each attempt, in seconds. Slow pages that exceed it are retried (maxRetries) and then reported in FAILED_URLS, not charged. Default: 30.", "default": 30 }, "maxRetries": { "title": "Retries per URL", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries for timeouts and browser errors. Default: 1.", "default": 1 }, "maxConcurrency": { "title": "Pages in parallel", "minimum": 1, "maximum": 8, "type": "integer", "description": "Pages captured at the same time. Default: 2 per GB of memory (2 at the default 1 GB), up to 8." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed. Use a proxy only for geo-specific views. Datacenter Apify Proxy or your own proxy URLs only; residential proxy isn't supported.", "default": { "useApifyProxy": false } }, "captureTimeoutSecs": { "title": "Capture timeout (s)", "minimum": 10, "maximum": 300, "type": "integer", "description": "Time allowed for rendering/encoding the image itself. Default 30 s. If a full-page capture times out, it is retried once cropped to the top 4,000 px (captureFallback: true in the output)." }, "maxLoadWaitMs": { "title": "Max wait for full load (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "With waitUntil=load: after the DOM is ready, wait at most this long for the load event (slow third-party assets no longer stall the run). Default: 10000.", "default": 10000 }, "detectBlockedPages": { "title": "Detect bot-check / blank pages", "type": "boolean", "description": "Treat bot walls ('Access denied', 'Just a moment...', 'Unknown Error') and blank renders as failures, so you are not charged for them. Default: true.", "default": true }, "pageTimeoutSecs": { "title": "Hard limit per page (s)", "minimum": 15, "maximum": 600, "type": "integer", "description": "Total time budget per URL attempt, default 60 s; pages that keep the browser busy longer are abandoned (not charged)." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }