{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot & PDF: Full-Page, Mobile, Change Alerts",
    "description": "Full-page website screenshots and PDFs in PNG, JPEG, WebP. Lazy-load scrolling, sticky headers fixed, cookie banners dismissed, mobile/tablet/desktop in one run, element and clip capture, visual change alerts with diff %. Same input as apify/screenshot-url. Failed pages are free.",
    "version": "0.1",
    "x-build-id": "M6hNGU26IXTNfadL4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nat-labs~website-screenshot-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nat-labs-website-screenshot-scraper",
        "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/nat-labs~website-screenshot-scraper/runs": {
      "post": {
        "operationId": "runs-sync-nat-labs-website-screenshot-scraper",
        "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/nat-labs~website-screenshot-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-nat-labs-website-screenshot-scraper",
        "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",
            "type": "array",
            "description": "Pages to capture. Full URLs or bare domains (\"example.com\"). Several URLs pasted into one line separated by spaces or new lines work too.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "sitemapUrls": {
            "title": "Sitemaps",
            "type": "array",
            "description": "Capture every page listed in these sitemap.xml files (sitemap indexes and .xml.gz supported), up to \"Max URLs\".",
            "items": {
              "type": "string"
            }
          },
          "maxUrls": {
            "title": "Max URLs",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Upper limit of URLs per run (each URL is captured once per device). 0 = 10,000.",
            "default": 1000
          },
          "devices": {
            "title": "Devices",
            "type": "array",
            "description": "One capture per device for every URL. Presets: desktop (1280×800), laptop (1440×900), desktop-hd (1920×1080), desktop-2k, mobile (iPhone 15), mobile-landscape, android (Pixel 7), tablet (iPad), tablet-landscape. Also any Playwright device name (\"iPhone 15 Pro Max\", \"Galaxy S24\") or a size like \"1366x768\" / \"390x844@3 mobile\".",
            "items": {
              "type": "string"
            }
          },
          "formats": {
            "title": "File formats",
            "type": "array",
            "description": "One file per format from the same page load: png, jpeg, webp, pdf. Each delivered file is one billable capture.",
            "items": {
              "type": "string",
              "enum": [
                "png",
                "jpeg",
                "webp",
                "pdf"
              ],
              "enumTitles": [
                "PNG",
                "JPEG",
                "WebP",
                "PDF"
              ]
            }
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the whole scrollable page (lazy images are scrolled into view first). Off = only the first screen (the viewport).",
            "default": true
          },
          "maxHeight": {
            "title": "Max image height (px)",
            "minimum": 100,
            "maximum": 30000,
            "type": "integer",
            "description": "Crop full-page captures to this many CSS pixels from the top, e.g. 3000 for \"the top of the page\". Empty = whole page (up to \"Page height limit\")."
          },
          "selector": {
            "title": "Element selector",
            "type": "string",
            "description": "Capture only this element (CSS selector, first match), e.g. \"#pricing\" or \"main article\". Pages where it never appears are reported as selector-not-found and not charged."
          },
          "clip": {
            "title": "Clip region",
            "type": "object",
            "description": "Capture a fixed rectangle of the page in CSS pixels: {\"x\": 0, \"y\": 0, \"width\": 1200, \"height\": 630} (e.g. social cards)."
          },
          "quality": {
            "title": "JPEG / WebP quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "1–100. Lower = smaller files.",
            "default": 80
          },
          "deviceScaleFactor": {
            "title": "Pixel density (retina)",
            "minimum": 1,
            "maximum": 4,
            "type": "integer",
            "description": "Override the device pixel ratio: 1 = standard, 2 = retina (4× the pixels). Leave empty to use each device's default."
          },
          "viewportWidth": {
            "title": "Custom viewport width",
            "minimum": 100,
            "maximum": 3840,
            "type": "integer",
            "description": "Shortcut for one custom desktop viewport when \"Devices\" is empty (apify/screenshot-url compatible)."
          },
          "viewportHeight": {
            "title": "Custom viewport height",
            "minimum": 100,
            "maximum": 4320,
            "type": "integer",
            "description": "Height of the custom viewport (also the image height when Full page is off)."
          },
          "maxPageHeight": {
            "title": "Page height limit (px)",
            "minimum": 500,
            "maximum": 30000,
            "type": "integer",
            "description": "Safety cap for endless pages: longer pages are cut here and flagged \"truncated\". WebP files are additionally limited to 16,383 px by the format.",
            "default": 20000
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. \"load\" suits most sites; \"networkidle\" waits for background requests to settle (bounded by the idle timeout, never hangs).",
            "default": "load"
          },
          "waitForSelector": {
            "title": "Wait for element",
            "type": "string",
            "description": "Wait until this CSS selector is visible before capturing (max 20 s, then captures anyway with a warning)."
          },
          "delay": {
            "title": "Extra delay",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Wait this long after the page is ready (animations, charts). Max 60,000 ms.",
            "default": 0
          },
          "scrollToBottom": {
            "title": "Scroll to load lazy content",
            "type": "boolean",
            "description": "Scroll down the page before capturing so lazy-loaded images and sections appear. On by default for full-page captures."
          },
          "delayAfterScrolling": {
            "title": "Delay after scrolling",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Extra wait after the lazy-load scroll.",
            "default": 0
          },
          "waitUntilNetworkIdleAfterScroll": {
            "title": "Wait for network idle after scrolling",
            "type": "boolean",
            "description": "After scrolling, wait (bounded by the idle timeout) until no requests are in flight.",
            "default": false
          },
          "networkIdleTimeoutMs": {
            "title": "Network idle timeout",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Longest wait for network idle. The page is captured when it is reached.",
            "default": 10000
          },
          "pageTimeoutSecs": {
            "title": "Per-page timeout",
            "minimum": 10,
            "maximum": 300,
            "type": "integer",
            "description": "Hard limit for one capture (load + waits + all files). A page that exceeds it is retried once, then reported as failed and not charged. The run never hangs on one page.",
            "default": 60
          },
          "dismissCookieBanners": {
            "title": "Dismiss cookie banners",
            "type": "boolean",
            "description": "Click the visible \"Accept\" button of common consent banners (OneTrust, Cookiebot, Didomi, Quantcast, Sourcepoint, Usercentrics, ...) and hide leftovers. Never touches CAPTCHAs.",
            "default": true
          },
          "stickyElements": {
            "title": "Sticky headers & floating widgets (full page)",
            "enum": [
              "unstick",
              "hide",
              "keep"
            ],
            "type": "string",
            "description": "unstick = fixed headers appear once at the top, floating chat bubbles/bottom bars are removed; hide = remove all fixed/sticky elements; keep = leave as rendered.",
            "default": "unstick"
          },
          "hideSelectors": {
            "title": "Hide elements",
            "type": "array",
            "description": "CSS selectors to hide before capturing (ads, popups, chat widgets).",
            "items": {
              "type": "string"
            }
          },
          "selectorsToHide": {
            "title": "Hide elements (single string)",
            "type": "string",
            "description": "apify/screenshot-url compatible: one CSS selector list, e.g. \".popup, #chat\"."
          },
          "css": {
            "title": "Custom CSS",
            "type": "string",
            "description": "CSS injected before capture, e.g. \"body { background: white }\"."
          },
          "blockAds": {
            "title": "Block ads & trackers",
            "type": "boolean",
            "description": "Skip requests to major ad/analytics hosts: faster loads and cleaner captures.",
            "default": true
          },
          "blockResources": {
            "title": "Block resource types",
            "type": "array",
            "description": "Do not load these request types. Default: media (video/audio — a screenshot cannot show it, and it costs CPU). Add font or image for speed; set to an empty list to load everything.",
            "items": {
              "type": "string",
              "enum": [
                "image",
                "media",
                "font",
                "stylesheet",
                "script",
                "xhr",
                "fetch",
                "websocket",
                "eventsource",
                "manifest",
                "other"
              ]
            },
            "default": [
              "media"
            ]
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Emulate prefers-color-scheme: dark (sites that support it render dark).",
            "default": false
          },
          "reducedMotion": {
            "title": "Reduce motion",
            "type": "boolean",
            "description": "Emulate prefers-reduced-motion (fewer animations; steadier captures for monitoring).",
            "default": false
          },
          "locale": {
            "title": "Locale",
            "type": "string",
            "description": "Browser language, e.g. en-US, de-DE, ja-JP. Sites that localise by Accept-Language follow it.",
            "default": "en-US"
          },
          "timezoneId": {
            "title": "Time zone",
            "type": "string",
            "description": "IANA time zone, e.g. Europe/Berlin. Empty = UTC."
          },
          "userAgent": {
            "title": "User agent",
            "type": "string",
            "description": "Override the device's user agent string."
          },
          "ignoreHttpsErrors": {
            "title": "Ignore HTTPS errors",
            "type": "boolean",
            "description": "Capture pages with expired or self-signed certificates.",
            "default": false
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3",
              "A5",
              "Tabloid"
            ],
            "type": "string",
            "description": "Paper size for PDF output.",
            "default": "A4"
          },
          "pdfLandscape": {
            "title": "Landscape PDF",
            "type": "boolean",
            "description": "Landscape orientation.",
            "default": false
          },
          "pdfMedia": {
            "title": "PDF styles",
            "enum": [
              "screen",
              "print"
            ],
            "type": "string",
            "description": "screen = the PDF looks like the page on screen; print = use the site's print stylesheet (cleaner articles).",
            "default": "screen"
          },
          "pdfPrintBackground": {
            "title": "Print backgrounds",
            "type": "boolean",
            "description": "Include background colours and images in the PDF.",
            "default": true
          },
          "pdfMarginPx": {
            "title": "PDF margin",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Margin on every side.",
            "default": 0
          },
          "onlyChanges": {
            "title": "Only deliver pages that changed (monitoring)",
            "type": "boolean",
            "description": "For scheduled runs: compare every capture with the last delivered one and deliver it only when it changed by at least the threshold, with the diff % and a highlighted diff image. Unchanged pages cost a cheaper monitor-check. The first run is the baseline.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Separate baselines per schedule/task (e.g. \"competitor-pricing\").",
            "default": "default"
          },
          "changeThresholdPercent": {
            "title": "Change threshold",
            "type": "string",
            "description": "Minimum share of the page (in %) that must differ to count as a change. Raise it for pages with rotating banners. Decimals allowed, e.g. \"0.5\".",
            "default": "1"
          },
          "changeTolerance": {
            "title": "Colour tolerance",
            "minimum": 0,
            "maximum": 255,
            "type": "integer",
            "description": "0–255. How much a region's colour may shift before it counts as changed (ignores anti-aliasing noise).",
            "default": 24
          },
          "includeUnchanged": {
            "title": "Also list unchanged pages",
            "type": "boolean",
            "description": "Add a row with status \"unchanged\" (no files) for pages that did not change.",
            "default": false
          },
          "diffImage": {
            "title": "Diff image",
            "type": "boolean",
            "description": "For changed pages, also store a JPEG with the changed regions highlighted (included in the price).",
            "default": true
          },
          "includeBase64": {
            "title": "Include files as base64",
            "type": "boolean",
            "description": "Also put each file (up to 5 MB) into the dataset as base64 — handy for AI agents and no-code tools that cannot download URLs.",
            "default": false
          },
          "keyValueStoreName": {
            "title": "Archive store name",
            "type": "string",
            "description": "Save files into this named key-value store (kept until you delete it, timestamped, never overwritten) instead of the run's default store."
          },
          "respectRobotsTxt": {
            "title": "Respect robots.txt",
            "type": "boolean",
            "description": "Skip pages a site's robots.txt disallows (reported, not charged). Switch off only for sites you own or are allowed to capture.",
            "default": true
          },
          "maxRetries": {
            "title": "Retries",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "Retries for timeouts and network errors (with a fresh proxy session when a proxy is used).",
            "default": 1
          },
          "maxConcurrency": {
            "title": "Parallel pages",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Pages rendered at once. 0 = automatic from the run memory (2 GB → 3).",
            "default": 0
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed for most sites (direct connection is fastest and included in the price). Use Apify datacenter proxy for other countries; RESIDENTIAL proxy is billed per MB of page traffic (residential-mb event)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}