{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full Page, Mobile & PDF", "description": "Capture PNG, JPEG or PDF screenshots of any public web page with headless Chrome. Full-page, custom viewport, mobile device emulation, dark mode, cookie-banner hiding. Public link per screenshot. Pay only for real captures: $3 per 1,000 screenshots, $10 per 1,000 full-page or PDF, $0.005 per run.", "version": "1.2", "x-build-id": "I9tdO2lwAGJOTCC3m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fairfetch~website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fairfetch-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/fairfetch~website-screenshot-api/runs": { "post": { "operationId": "runs-sync-fairfetch-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/fairfetch~website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-fairfetch-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": "Web pages to capture, one per line. \"https://\" is added when missing. Only public http(s) pages are supported.", "items": { "type": "string" } }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG (lossless), JPEG (smaller files) or PDF (printable document of the page). PDFs are charged as full-page captures ($0.01 each).", "default": "png" }, "fullPage": { "title": "Full-page screenshot", "type": "boolean", "description": "Capture the whole scrollable page instead of just the visible viewport (pages taller than 20,000 px are cut at 20,000 px). Full-page captures cost $0.01 each instead of $0.003.", "default": false }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Browser window width. Ignored when a device preset is selected.", "default": 1280 }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 2160, "type": "integer", "description": "Browser window height (also the screenshot height when full-page is off). Ignored when a device preset is selected.", "default": 800 }, "device": { "title": "Device emulation", "enum": [ "none", "iPhone 15", "iPhone 15 Pro Max", "iPhone 17 Pro", "iPhone SE (3rd gen)", "Pixel 7", "Pixel 9", "Galaxy S24", "iPad Pro 11", "iPad Mini", "Desktop Chrome HiDPI" ], "type": "string", "description": "Emulate a phone, tablet or HiDPI desktop (screen size, pixel ratio, touch and user agent). Choose \"None\" to use the viewport size above.", "default": "none" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100. Only used for JPEG.", "default": 80 }, "colorScheme": { "title": "Color scheme", "enum": [ "light", "dark" ], "type": "string", "description": "Emulate light or dark mode (prefers-color-scheme).", "default": "light" }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3" ], "type": "string", "description": "Only used for PDF output.", "default": "A4" }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ], "type": "string", "description": "When navigation counts as finished: \"load\" (default), \"domcontentloaded\" (faster), \"networkidle\" (no network activity for 500 ms; best for heavy JavaScript apps, slower) or \"commit\".", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Additional wait after the page has loaded, e.g. for animations or late content.", "default": 0 }, "scrollToBottom": { "title": "Scroll to bottom first", "type": "boolean", "description": "Scroll through the page before capturing to trigger lazy-loaded images (useful with full-page screenshots).", "default": false }, "timeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum time for the page HTML to arrive. After that, the Actor waits up to 10 more seconds for the \"Wait until\" state and then captures whatever has rendered. Each URL gets at most this timeout + extra delay + 60 seconds in total, retries included.", "default": 30 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common cookie-consent pop-ups (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast and generic banners) with CSS. Nothing is clicked or accepted.", "default": true }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "Extra elements to hide before capturing, e.g. chat widgets or ads: \"#intercom-container\", \".newsletter-popup\". Invalid selectors are skipped and listed in the item's note.", "items": { "type": "string" } }, "ignoreHttpsErrors": { "title": "Ignore HTTPS errors", "type": "boolean", "description": "Capture pages whose HTTPS certificate is invalid or self-signed. Off by default, so a page served with a bad certificate fails (free) instead of being captured like a trusted page.", "default": false }, "skipContentCheck": { "title": "Skip the content check", "type": "boolean", "description": "Off by default: blank pages, bot walls, challenge pages and error pages served as normal pages are free and get no file. Turn this on to capture (and pay for) every page that loads with an HTTP status below 400, for example if a legitimate page of yours is wrongly treated as blank or blocked.", "default": false }, "maxConcurrency": { "title": "Parallel browser tabs", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured at the same time. 3 suits the default 2 GB of memory. Full-page and PDF captures use at most 1 tab per GB of memory (2 at 2 GB); give the run more memory to capture more of them at once.", "default": 3 }, "maxRetries": { "title": "Retries per URL", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to retry a page after a network error or a browser crash (not after HTTP errors, bot walls or timeouts). All attempts share the time limit per URL.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Use the Apify datacenter proxy (default group) or your own http:// proxy URLs if some sites block the default IP addresses. Residential and Google SERP proxy groups are not supported (the run stops with \"Invalid input\" and nothing is charged).", "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 } } } } } } } } } }