{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API - Full Page, Mobile & PDF", "description": "Screenshot any list of URLs with headless Chrome: full page, viewport or element, desktop/tablet/iPhone/Android, PNG/JPEG/PDF, dark mode, cookie banners and ads hidden. Public image links. From $1.50 per 1,000; failed URLs free.", "version": "1.0", "x-build-id": "3Ub1rp58C245oBahe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearscrape~website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearscrape-website-screenshot-api", "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/clearscrape~website-screenshot-api/runs": { "post": { "operationId": "runs-sync-clearscrape-website-screenshot-api", "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/clearscrape~website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-clearscrape-website-screenshot-api", "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": "Pages to capture, one per line. 'https://' is added if missing. Duplicates are removed.", "items": { "type": "string" } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "iphone", "android", "custom" ], "type": "string", "description": "Viewport preset. Desktop 1920x1080, Laptop 1366x768, Tablet 820x1180 (iPad), iPhone 393x852 @3x, Android 412x915 (Pixel 8), or Custom (set width/height below).", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of just the visible viewport.", "default": true }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG (lossless), JPEG (smaller files) or PDF (printable, selectable text).", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100, only for JPEG.", "default": 80 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Clicks 'accept' on common consent tools (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast...) and hides leftover banners.", "default": true }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Blocks common ad, analytics and chat-widget domains. Cleaner, faster screenshots.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulates prefers-color-scheme: dark.", "default": false }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "Elements to hide before capturing, e.g. .newsletter-popup, #chat-widget.", "items": { "type": "string" } }, "elementSelector": { "title": "Capture only this element", "type": "string", "description": "CSS selector of a single element to capture (e.g. #pricing). Leave empty for the page." }, "customCss": { "title": "Custom CSS", "type": "string", "description": "CSS injected before capturing." }, "customJs": { "title": "Custom JavaScript", "type": "string", "description": "JavaScript expression evaluated in the page before capturing (e.g. to close a modal)." }, "waitUntil": { "title": "Wait until", "enum": [ "domcontentloaded", "load", "networkidle" ], "type": "string", "description": "When navigation counts as finished. 'Network idle' is best for heavy single-page apps but slower.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after loading (for animations/fonts).", "default": 500 }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector that must appear before capturing." }, "scrollToLoadLazy": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scrolls through the page first so lazy-loaded images appear in full-page shots.", "default": true }, "navigationTimeoutSecs": { "title": "Page timeout (s)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Max time for a page to load.", "default": 45 }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the device width (required for Custom)." }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Overrides the device height." }, "deviceScaleFactor": { "title": "Device scale factor", "minimum": 1, "maximum": 3, "type": "integer", "description": "Pixel density (1 = normal, 2 = retina). Higher = sharper but bigger files." }, "maxFullPageHeight": { "title": "Max full-page height (px)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Very long pages are cut at this height.", "default": 10000 }, "pdfPageFormat": { "title": "PDF page format", "enum": [ "A4", "Letter", "Legal", "A3" ], "type": "string", "description": "Paper size for PDF output.", "default": "A4" }, "userAgent": { "title": "User agent", "type": "string", "description": "Override the browser user agent." }, "locale": { "title": "Locale", "type": "string", "description": "Browser locale / Accept-Language, e.g. en-US, de-DE, en-AU.", "default": "en-US" }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured at once. About 1-2 per GB of memory (full-page shots of long pages use a lot of memory).", "default": 3 }, "maxRetries": { "title": "Retries per URL", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for pages that fail to load or block the request.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most sites. If pages block direct access, the Actor switches to Apify datacenter proxy automatically; choose Residential for geo-specific or heavily protected sites.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }