{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot API – Bulk Full-Page, Mobile & PDF",
    "description": "Website screenshot API. Input: URLs, domains or a sitemap. Returns one row per URL with a full-page screenshot (desktop, mobile, tablet; PNG/JPEG/WebP) and optional URL to PDF. Accepts cookie banners, removes popups, ads and chat. $0.003 per screenshot; failed or bot-blocked URLs free. MCP-ready.",
    "version": "1.0",
    "x-build-id": "mkzYzyXaYMHAXCBn4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ausbizstack~website-screenshot-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ausbizstack-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/ausbizstack~website-screenshot-api/runs": {
      "post": {
        "operationId": "runs-sync-ausbizstack-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/ausbizstack~website-screenshot-api/run-sync": {
      "post": {
        "operationId": "run-sync-ausbizstack-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",
        "properties": {
          "urls": {
            "title": "URLs or domains",
            "type": "array",
            "description": "Websites to capture, one per line. Domains without https:// are fine (stripe.com). One output row per line, duplicates included. You can also pass objects like {\"url\": \"https://...\", \"userData\": {...}} through the API; userData is copied to the output row.",
            "items": {
              "type": "string"
            }
          },
          "sitemapUrl": {
            "title": "Sitemap URL (optional)",
            "type": "string",
            "description": "Capture every page listed in an XML sitemap (sitemap index and .xml.gz supported), e.g. https://example.com/sitemap.xml. Added to the URLs above."
          },
          "maxSitemapUrls": {
            "title": "Max pages from sitemap",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Upper limit of pages taken from the sitemap.",
            "default": 50
          },
          "viewport": {
            "title": "Device",
            "enum": [
              "desktop",
              "mobile",
              "tablet",
              "both",
              "all"
            ],
            "type": "string",
            "description": "Desktop (1440×900 by default), mobile (iPhone 13, 390×844), tablet (iPad), desktop + mobile, or all three. Each device image is one charged screenshot.",
            "default": "desktop"
          },
          "devicePresets": {
            "title": "Device presets (overrides Device)",
            "type": "array",
            "description": "Pick exact devices instead of the Device option above. Each preset is one screenshot.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "desktop-hd",
                "laptop",
                "mobile",
                "iphone-15-pro-max",
                "pixel-7",
                "galaxy-s9",
                "tablet",
                "ipad-pro"
              ],
              "enumTitles": [
                "Desktop (custom width/height)",
                "Desktop Full HD 1920×1080",
                "Laptop 1280×800",
                "iPhone 13",
                "iPhone 15 Pro Max",
                "Pixel 7",
                "Galaxy S9+",
                "iPad",
                "iPad Pro 11"
              ]
            }
          },
          "fullPage": {
            "title": "Full-page screenshot",
            "type": "boolean",
            "description": "Capture the whole scrollable page (lazy-loaded images are loaded first). Turn off to capture only the visible viewport (above the fold).",
            "default": true
          },
          "width": {
            "title": "Desktop width (px)",
            "minimum": 240,
            "maximum": 3840,
            "type": "integer",
            "description": "Viewport width for the desktop device.",
            "default": 1440
          },
          "height": {
            "title": "Desktop height (px)",
            "minimum": 240,
            "maximum": 4320,
            "type": "integer",
            "description": "Viewport height for the desktop device (the image height when Full-page is off).",
            "default": 900
          },
          "deviceScaleFactor": {
            "title": "Pixel density (retina)",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "1 = normal, 2 = retina (2× sharper, ~3× bigger files), 3 = max. Leave empty for 1 on desktop and 2 on mobile/tablet."
          },
          "maxFullPageHeight": {
            "title": "Max full-page height (px)",
            "minimum": 1000,
            "maximum": 30000,
            "type": "integer",
            "description": "Very tall pages (infinite scroll, long articles) are cut at this height so images stay usable.",
            "default": 15000
          },
          "selector": {
            "title": "Element selector (optional)",
            "type": "string",
            "description": "CSS selector of one element to capture instead of the page, e.g. header, #pricing, .hero. Rows where the element is missing are marked error and not charged."
          },
          "format": {
            "title": "Image format",
            "enum": [
              "jpeg",
              "png",
              "webp"
            ],
            "type": "string",
            "description": "JPEG is smallest for photos, PNG is lossless, WebP is small and sharp.",
            "default": "jpeg"
          },
          "quality": {
            "title": "JPEG / WebP quality",
            "minimum": 10,
            "maximum": 100,
            "type": "integer",
            "description": "10-100. Ignored for PNG.",
            "default": 80
          },
          "pdf": {
            "title": "Also save a PDF",
            "type": "boolean",
            "description": "Save a PDF of each page as well (charged as an extra pdf-generated event).",
            "default": false
          },
          "pdfOnly": {
            "title": "PDF only (no image)",
            "type": "boolean",
            "description": "Save only the PDF, no screenshot. Charged as a single pdf-generated event per URL.",
            "default": false
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3",
              "Tabloid"
            ],
            "type": "string",
            "description": "Paper size for PDFs.",
            "default": "A4"
          },
          "pdfLandscape": {
            "title": "PDF landscape",
            "type": "boolean",
            "description": "Landscape orientation for PDFs.",
            "default": false
          },
          "hideCookieBanners": {
            "title": "Accept & hide cookie banners",
            "type": "boolean",
            "description": "Clicks “Accept” on 40+ consent platforms (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics, TrustArc, Sourcepoint, Google Funding Choices, CookieYes, Osano, iubenda, Complianz…) in many languages, then hides any leftover banner and unlocks scrolling.",
            "default": true
          },
          "hideChatWidgets": {
            "title": "Hide chat widgets",
            "type": "boolean",
            "description": "Hides Intercom, Drift, HubSpot, Zendesk, Tawk.to, Crisp, LiveChat, Tidio, Freshchat, Zoho SalesIQ and other chat bubbles.",
            "default": true
          },
          "blockAds": {
            "title": "Block ads & trackers",
            "type": "boolean",
            "description": "Blocks common ad, tracking and push-notification networks (faster pages, cleaner images).",
            "default": true
          },
          "hidePopups": {
            "title": "Remove popups & modals",
            "type": "boolean",
            "description": "Removes newsletter, sign-in, paywall-teaser and “disable your ad blocker” modals plus their dark backdrops, and unlocks scrolling. Sticky navigation bars are kept.",
            "default": true
          },
          "blockVideos": {
            "title": "Block video & audio streams",
            "type": "boolean",
            "description": "Skip loading videos/audio (posters still show). Faster, cheaper, and stills never show video frames reliably anyway.",
            "default": true
          },
          "disableWebGL": {
            "title": "Disable WebGL",
            "type": "boolean",
            "description": "Turn off WebGL/3D canvases. Much faster on sites with animated 3D backgrounds; the site shows its static fallback instead.",
            "default": false
          },
          "disableAnimations": {
            "title": "Freeze animations",
            "type": "boolean",
            "description": "Stops CSS animations and transitions and hides the text cursor so screenshots are stable.",
            "default": true
          },
          "hideSelectors": {
            "title": "Extra elements to hide",
            "type": "array",
            "description": "CSS selectors to hide before capture, e.g. .promo-bar, #newsletter-popup.",
            "items": {
              "type": "string"
            }
          },
          "customCss": {
            "title": "Custom CSS",
            "type": "string",
            "description": "CSS injected before capture."
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Emulate prefers-color-scheme: dark (sites that support dark mode render dark).",
            "default": false
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. “Load” works for most sites; “Network idle” waits longer for heavy single-page apps.",
            "default": "load"
          },
          "delayMs": {
            "title": "Extra delay before capture (ms)",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Wait this long after the page is ready.",
            "default": 500
          },
          "waitForSelector": {
            "title": "Wait for element (optional)",
            "type": "string",
            "description": "CSS selector that must be visible before the screenshot, e.g. .chart-loaded."
          },
          "scrollToLoadLazy": {
            "title": "Scroll to load lazy content",
            "type": "boolean",
            "description": "For full-page shots and PDFs, scroll through the page first so lazy-loaded images and sections appear.",
            "default": true
          },
          "timeoutSecs": {
            "title": "Page timeout (seconds)",
            "minimum": 10,
            "maximum": 180,
            "type": "integer",
            "description": "Maximum time for a page to respond. Slow pages are marked timeout and not charged.",
            "default": 45
          },
          "retries": {
            "title": "Retries",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "Retries per URL after a timeout or network error.",
            "default": 1
          },
          "concurrency": {
            "title": "Parallel pages",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Pages rendered at the same time. Leave empty for auto (2 pages per GB of memory, so 8 at the default 4 GB, automatically lowered when each URL needs several devices or a PDF). Most time is spent waiting on the network, so this is the fastest and cheapest setting for most batches."
          },
          "maxUrls": {
            "title": "Max URLs per run",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Safety limit on the number of URLs processed.",
            "default": 10000
          },
          "locale": {
            "title": "Browser language",
            "type": "string",
            "description": "Browser locale and Accept-Language, e.g. en-US, en-AU, de-DE.",
            "default": "en-US"
          },
          "timezoneId": {
            "title": "Time zone",
            "type": "string",
            "description": "IANA time zone, e.g. Australia/Sydney, Europe/London."
          },
          "userAgent": {
            "title": "Custom user agent",
            "type": "string",
            "description": "Override the browser user agent."
          },
          "headers": {
            "title": "Custom HTTP headers",
            "type": "object",
            "description": "Extra request headers, e.g. {\"Authorization\": \"Basic ...\"} for a staging site."
          },
          "cookies": {
            "title": "Cookies",
            "type": "array",
            "description": "Cookies to set before loading, e.g. [{\"name\": \"session\", \"value\": \"...\", \"domain\": \".example.com\"}]. Use only for sites you own or are allowed to access."
          },
          "proxyConfiguration": {
            "title": "Proxy (optional)",
            "type": "object",
            "description": "Not needed for most sites. Add your own proxy URLs (e.g. http://user:pass@host:port) for geo-specific or bot-protected pages. Apify Proxy is not supported in this Actor."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}