{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API (Full Page, Mobile, No Cookie Banners)", "description": "Full-page screenshots without cookie banners or ads, as PNG, JPEG or PDF. $4 per 1,000. Pages that return 4xx or 5xx are delivered but not charged.", "version": "0.1", "x-build-id": "46reARegqkmLPaSzo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/isnard~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-isnard-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/isnard~website-screenshot/runs": { "post": { "operationId": "runs-sync-isnard-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/isnard~website-screenshot/run-sync": { "post": { "operationId": "run-sync-isnard-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Pages to capture, one per line. https:// is added when no scheme is given. Duplicates are captured once.", "items": { "type": "string" } }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG is lossless. JPEG (quality 80) is much smaller. PDF prints the page with backgrounds on Letter-size pages; Full page and Element selector are ignored for PDF.", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the visible viewport. The page is scrolled once first so lazy images load.", "default": false }, "viewport": { "title": "Viewport", "enum": [ "desktop", "mobile", "tablet", "custom" ], "type": "string", "description": "Desktop is 1366x768. Mobile is 390x844 (iPhone user agent, 2x pixels). Tablet is 820x1180 (iPad user agent, 2x pixels). Custom uses the width and height below.", "default": "desktop" }, "viewportWidth": { "title": "Custom width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Only used with the Custom viewport.", "default": 1366 }, "viewportHeight": { "title": "Custom height", "minimum": 200, "maximum": 2160, "type": "integer", "description": "Only used with the Custom viewport.", "default": 768 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "networkidle" ], "type": "string", "description": "Load waits for the load event. Network idle also waits until there are no requests for 0.5 s, which some busy sites never reach. When an attempt times out, the retry waits for less: Network idle, then Load, then DOM ready.", "default": "load" }, "delayMs": { "title": "Extra delay", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after the page loads, before the screenshot. Useful for animations and late content.", "default": 0 }, "selector": { "title": "Element selector", "type": "string", "description": "Optional CSS selector. When set, only the first matching element is captured. A missing element is reported as an error." }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide consent banners of OneTrust, Cookiebot, Didomi, Quantcast, Sourcepoint, Usercentrics, TrustArc and similar, plus generic cookie bars and fixed boxes that mention cookies or consent. Nothing is clicked.", "default": true }, "clickCookieAccept": { "title": "Click Accept on cookie banners", "type": "boolean", "description": "Also try to click the accept button of the consent banner before the screenshot. This gives consent on your behalf and can make the site load more ads and trackers.", "default": false }, "blockAds": { "title": "Block ads", "type": "boolean", "description": "Block requests to common ad and tracking networks (DoubleClick, Taboola, Outbrain, Criteo and others). Ad slots may stay as empty boxes.", "default": false }, "timeoutSecs": { "title": "Timeout per attempt", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum time for the page to load in each attempt.", "default": 30 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Extra attempts when loading or capturing fails. Each retry waits for less than the attempt before it. Hosts that do not exist are not retried.", "default": 1 } } }, "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 } } } } } } } } } }