{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full Page, Bulk & PDF", "description": "Website screenshot API for bulk, true full-page captures from URLs or sitemaps: lazy images loaded, sticky headers and cookie banners removed. PNG/JPEG/WebP/PDF, change detection. No subscription: $0.004 per screenshot, under half the entry-plan rate of ScreenshotOne and Urlbox. Failed URLs free.", "version": "0.1", "x-build-id": "yRA1r5Al66Ibwb7ge" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tobbyb~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tobbyb-website-screenshot", "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/tobbyb~website-screenshot/runs": { "post": { "operationId": "runs-sync-tobbyb-website-screenshot", "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/tobbyb~website-screenshot/run-sync": { "post": { "operationId": "run-sync-tobbyb-website-screenshot", "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", "properties": { "urls": { "title": "URLs to screenshot", "type": "array", "description": "Pages to capture, one per line. Bare domains like example.com work too. Each URL × device is one screenshot.", "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemaps (optional)", "type": "array", "description": "Sitemap XML URLs (indexes and .xml.gz are fine) or a site homepage, in which case the sitemap is found via robots.txt. Every page URL in them is captured, up to \"Max URLs from sitemaps\".", "items": { "type": "string" } }, "maxSitemapUrls": { "title": "Max URLs from sitemaps", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Upper limit on page URLs taken from the sitemaps.", "default": 100 }, "devices": { "title": "Devices", "type": "array", "description": "Pick one or more. Each device is a separate screenshot (and a separate charge).", "items": { "type": "string", "enum": [ "desktop", "desktop-hd", "laptop", "tablet", "mobile" ], "enumTitles": [ "Desktop 1440×900", "Full HD 1920×1080", "Laptop 1280×800", "Tablet (iPad) 820×1180 @2x", "Mobile (iPhone) 390×844 @2x" ] }, "default": [ "desktop" ] }, "formats": { "title": "Output formats", "type": "array", "description": "One or more. Each file is charged as one screenshot. WebP pages taller than 16,383 px are saved as JPEG.", "items": { "type": "string", "enum": [ "jpeg", "png", "webp", "pdf" ], "enumTitles": [ "JPEG", "PNG (lossless, larger)", "WebP", "PDF" ] }, "default": [ "jpeg" ] }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page (on) or just the first screen (off).", "default": true }, "maxHeight": { "title": "Max page height (px)", "minimum": 200, "maximum": 60000, "type": "integer", "description": "Safety cap for endless pages. If a page is taller, the first part is captured and the result says so (fullPageComplete=false). Use it to grab only the top N pixels too.", "default": 30000 }, "selector": { "title": "Capture element (CSS selector)", "type": "string", "description": "Capture only this element, e.g. #pricing or .hero. Leave empty for the whole page." }, "viewportWidth": { "title": "Custom viewport width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the device width (e.g. 1366). Leave empty to use device presets." }, "viewportHeight": { "title": "Custom viewport height", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Viewport height for custom size (also the height of a non-full-page shot)." }, "deviceScaleFactor": { "title": "Pixel ratio (retina)", "enum": [ "0.5", "1", "1.5", "2", "3" ], "type": "string", "description": "Override the device pixel ratio. 2 = retina. Bigger files." }, "quality": { "title": "JPEG/WebP quality", "minimum": 10, "maximum": 100, "type": "integer", "description": "Higher = sharper and larger files.", "default": 85 }, "pdfFormat": { "title": "PDF page size", "enum": [ "A4", "Letter", "Legal", "A3", "single-page" ], "type": "string", "description": "single-page = one long page exactly like the screen.", "default": "A4" }, "pdfMedia": { "title": "PDF CSS media", "enum": [ "screen", "print" ], "type": "string", "description": "screen = looks like the website; print = the site's print stylesheet.", "default": "screen" }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Wait until this element is visible before capturing (e.g. a chart or price)." }, "waitForSelectorTimeoutSecs": { "title": "Wait-for-selector timeout (s)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Give up and return a free WAIT_FOR_SELECTOR_TIMEOUT error after this.", "default": 15 }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Additional wait before capturing, for animations or slow widgets.", "default": 0 }, "scrollToLoadLazyContent": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Scrolls through the page first so lazy-loaded images and scroll-triggered sections render. Fast (about 1–4 s per page).", "default": true }, "dismissCookieBanners": { "title": "Remove cookie banners", "type": "boolean", "description": "Blocks common consent-manager scripts, clicks \"Accept\" when a banner still appears, and hides leftovers.", "default": true }, "blockAds": { "title": "Block ads & trackers", "type": "boolean", "description": "Faster loads and no empty ad boxes. Also hides chat widgets.", "default": true }, "stickyElements": { "title": "Sticky / fixed elements", "enum": [ "smart", "hide", "off" ], "type": "string", "description": "How fixed headers, chat bubbles and bottom bars are handled on full-page shots.", "default": "smart" }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "Anything else to remove before capturing, e.g. .promo-bar.", "items": { "type": "string" } }, "clickSelectors": { "title": "Click elements first", "type": "array", "description": "Elements to click before capturing (e.g. a tab or \"Show more\").", "items": { "type": "string" } }, "customCss": { "title": "Custom CSS", "type": "string", "description": "Injected before capturing." }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulates prefers-color-scheme: dark.", "default": false }, "reducedMotion": { "title": "Reduce motion", "type": "boolean", "description": "Asks the site to skip animations (prefers-reduced-motion), so nothing is captured mid-fade.", "default": true }, "userAgent": { "title": "User agent", "type": "string", "description": "Override the browser user agent." }, "locale": { "title": "Locale", "type": "string", "description": "Accept-Language / navigator.language, e.g. de-DE.", "default": "en-US" }, "timezone": { "title": "Time zone", "type": "string", "description": "IANA time zone, e.g. Europe/Berlin." }, "cookies": { "title": "Cookies", "type": "array", "description": "Cookies to set, e.g. [{\"name\":\"session\",\"value\":\"…\",\"domain\":\".example.com\"}]. Only for pages you are allowed to access." }, "ignoreHttpsErrors": { "title": "Ignore HTTPS errors", "type": "boolean", "description": "Capture sites with expired/self-signed certificates.", "default": false }, "captureErrorPages": { "title": "Capture error pages", "type": "boolean", "description": "Also capture pages that answer 4xx/5xx (charged). Off = they become free error items.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use Apify Proxy for sites that block datacenter IPs. No CAPTCHA or bot-check bypass." }, "changeDetectionName": { "title": "Change detection name", "type": "string", "description": "Turn on visual change detection: give the monitor a name (e.g. competitors). Each run compares every page with the previous run under this name and reports diffPercent plus a diff image. Schedule the Actor to monitor." }, "changeThresholdPercent": { "title": "Change threshold (%)", "type": "string", "description": "A page counts as changed when at least this % of pixels differ.", "default": "1" }, "saveDiffImage": { "title": "Save diff image", "type": "boolean", "description": "Saves an image with changed pixels highlighted in red.", "default": true }, "maxUrls": { "title": "Max screenshots per run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on URL × device captures in one run.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured in parallel. Default: 3 per 2 GB of memory." }, "pageTimeoutSecs": { "title": "Page load timeout (s)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Per page. Slow pages fail with a free TIMEOUT item.", "default": 45 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries for timeouts and connection errors.", "default": 1 }, "galleryReport": { "title": "HTML gallery", "type": "boolean", "description": "Saves a GALLERY page with thumbnails, change badges and errors.", "default": true } } }, "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 } } } } } } } } } }