{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Pro — Bulk, Full Page, Mobile & PDF", "description": "Take screenshots of many websites at once: full page, viewport, mobile/tablet, a single element or PDF. Hides cookie banners, fixes sticky headers, loads lazy images, renders emoji and Chinese text. You only pay for screenshots that succeed.", "version": "1.0", "x-build-id": "AKLPAwdQZfyErQfUh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/newbeeer~website-screenshot-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-newbeeer-website-screenshot-pro", "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/newbeeer~website-screenshot-pro/runs": { "post": { "operationId": "runs-sync-newbeeer-website-screenshot-pro", "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/newbeeer~website-screenshot-pro/run-sync": { "post": { "operationId": "run-sync-newbeeer-website-screenshot-pro", "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 screenshot. One screenshot per URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "custom" ], "type": "string", "description": "Screen to emulate. Tablet and mobile also set a matching user agent and touch support.", "default": "desktop" }, "width": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the device width. Required for Custom." }, "height": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Overrides the device height. With Full page off, this is the image height." }, "deviceScaleFactor": { "title": "Pixel density (1–3)", "minimum": 1, "maximum": 3, "type": "integer", "description": "2 or 3 gives sharp retina-quality images.", "default": 1 }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page. Off captures only the visible screen.", "default": true }, "clipHeight": { "title": "Crop to top N pixels", "minimum": 100, "type": "integer", "description": "Capture only the top part of the page, e.g. 2000 for the first 2000 px." }, "selector": { "title": "Only this element (CSS selector)", "type": "string", "description": "Screenshot a single element, e.g. #pricing or .product-card. Leave empty for the page." }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG is lossless. JPEG gives much smaller files. PDF keeps text selectable.", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only used for JPEG. Lower means smaller files.", "default": 80 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the site for its dark theme (prefers-color-scheme: dark).", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common cookie and consent pop-ups so they don't cover the page.", "default": true }, "fixStickyElements": { "title": "Fix sticky headers and floating widgets", "type": "boolean", "description": "Turn on if a header or chat bubble overlaps content in full-page shots. Pins top bars to the top and hides other floating elements. Off by default because a few sites lay out differently with it.", "default": false }, "hideSelectors": { "title": "Hide these elements (CSS selectors)", "type": "array", "description": "Extra elements to hide, e.g. .newsletter-popup or #chat-widget.", "items": { "type": "string" } }, "scrollToBottom": { "title": "Load lazy images", "type": "boolean", "description": "Scroll through the page before a full-page shot so lazy images load.", "default": true }, "maxScrollSecs": { "title": "Max scroll time (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Stops scrolling after this long, so endless feeds don't hang the run.", "default": 10 }, "waitUntil": { "title": "Wait until", "enum": [ "domcontentloaded", "load", "networkidle" ], "type": "string", "description": "When to consider the page loaded. Network idle waits longest and captures the most complete page.", "default": "load" }, "waitForSelector": { "title": "Wait for element (CSS selector)", "type": "string", "description": "Wait until this element appears before taking the screenshot." }, "delaySecs": { "title": "Extra delay (seconds)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Wait this long after loading, for animations or late content.", "default": 1 }, "pageTimeoutSecs": { "title": "Page load timeout (seconds)", "minimum": 5, "maximum": 300, "type": "integer", "description": "If a page is still loading after this, the screenshot is taken anyway and marked partial.", "default": 60 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many pages to load at the same time. Higher is faster but needs more memory.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use a proxy, for example to see a site from another country." } } }, "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 } } } } } } } } } }