{
  "openapi": "3.0.1",
  "info": {
    "title": "Bulk Website Screenshot Tool | Full Page, URL to PNG & PDF",
    "description": "Extract website screenshots of many URLs at $1.50 per 1,000 on the free plan: URL to PNG, JPEG, WebP or PDF, cookie banners and popups hidden, ads blocked. Full page screenshots with lazy images loaded as an add-on; desktop to mobile, element shots, a changed-since-last-run flag. No login.",
    "version": "0.1",
    "x-build-id": "UbV92TlFVU4W93A1e"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/aurelix~website-screenshot/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-aurelix-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/aurelix~website-screenshot/runs": {
      "post": {
        "operationId": "runs-sync-aurelix-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/aurelix~website-screenshot/run-sync": {
      "post": {
        "operationId": "run-sync-aurelix-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": "Page URLs",
            "type": "array",
            "description": "Pages to capture, one per line, e.g. ['https://apify.com', 'https://www.python.org']. A URL without http(s):// gets https://. Duplicates are captured once. Only pages a logged-out visitor can see; you must have the right to capture them.",
            "items": {
              "type": "string"
            }
          },
          "device": {
            "title": "Device",
            "enum": [
              "desktop",
              "laptop",
              "tablet",
              "mobile",
              "custom"
            ],
            "type": "string",
            "description": "Screen to emulate, e.g. 'mobile'. desktop = 1920x1080, laptop = 1366x768, tablet = 820x1180 (iPad Air size, 2x pixels), mobile = 390x844 (iPhone 14 size, 2x pixels, mobile browser), custom = the width and height below at 1x.",
            "default": "desktop"
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "false = the visible screen, e.g. 1920x1080 on desktop (the base price). true = the whole scrollable page, scrolled first so lazy-loaded images appear, up to Max full-page height; adds the full-page charge per screenshot.",
            "default": false
          },
          "format": {
            "title": "Image format",
            "enum": [
              "jpeg",
              "png",
              "webp",
              "pdf"
            ],
            "type": "string",
            "description": "File type, e.g. 'png'. jpeg = small files and fast (default), png = lossless and larger, webp = smallest files, pdf = a printable PDF of the whole page on the paper size below (always charged as full page).",
            "default": "jpeg"
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners and popups",
            "type": "boolean",
            "description": "true = hide cookie and consent banners (about 60 rules for OneTrust, Cookiebot, Didomi, Quantcast, TrustArc, Usercentrics and other consent tools, plus a text check) and newsletter sign-up popups before the screenshot. Nothing is clicked or accepted. false = capture the page as a first-time visitor sees it.",
            "default": true
          },
          "hideSelectors": {
            "title": "Hide these elements",
            "type": "array",
            "description": "CSS selectors to hide before the screenshot, e.g. ['#chat-widget', '.ad-slot', 'header']. Useful for chat bubbles, ads or anything that changes on every visit.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "blockAds": {
            "title": "Block ads and trackers",
            "type": "boolean",
            "description": "true = do not load common ad, analytics and video-player requests (about 50 ad and tracker networks), so ad slots stay empty and pages load faster. false = load everything the page asks for.",
            "default": true
          },
          "selector": {
            "title": "Element to capture (CSS selector)",
            "type": "string",
            "description": "Capture only one element instead of the page, e.g. '#pricing' or 'main article'. The first match is used; if nothing matches, that URL fails and is not charged. Leave empty for the page.",
            "default": ""
          },
          "waitForSelector": {
            "title": "Wait for element (CSS selector)",
            "type": "string",
            "description": "Wait until this element is visible before capturing, e.g. '.chart canvas' or '#results'. If it never shows within the per-URL timeout, that URL fails and is not charged. Leave empty to capture once the page has loaded.",
            "default": ""
          },
          "delayMs": {
            "title": "Extra delay (milliseconds)",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Wait this long after the page has loaded, e.g. 2000 for pages with animations or slow charts. 0 = no extra wait.",
            "default": 0
          },
          "scrollToLoad": {
            "title": "Scroll to load lazy images",
            "type": "boolean",
            "description": "true = with Full page on, scroll down the page first so lazy-loaded images and sections are loaded, then back to the top (skipped when the page fits on one screen). Only used for full-page PNG, JPEG and WebP.",
            "default": true
          },
          "quality": {
            "title": "Quality (JPEG and WebP)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Compression quality for jpeg and webp, e.g. 80. Higher = sharper and bigger files. Ignored for png and pdf.",
            "default": 80
          },
          "viewportWidth": {
            "title": "Custom width (pixels)",
            "minimum": 200,
            "maximum": 3840,
            "type": "integer",
            "description": "Browser width when Device is 'custom', e.g. 1440.",
            "default": 1920
          },
          "viewportHeight": {
            "title": "Custom height (pixels)",
            "minimum": 200,
            "maximum": 2160,
            "type": "integer",
            "description": "Browser height when Device is 'custom', e.g. 900. With Full page on, this is only the starting screen height.",
            "default": 1080
          },
          "maxHeight": {
            "title": "Max full-page height (pixels)",
            "minimum": 1000,
            "maximum": 16000,
            "type": "integer",
            "description": "Full-page screenshots stop at this height in CSS pixels, e.g. 10000; taller pages are cut and marked truncated: true. Keeps infinite-scroll pages from producing endless images.",
            "default": 16000
          },
          "pdfPaper": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3"
            ],
            "type": "string",
            "description": "Paper size when Image format is 'pdf', e.g. 'Letter'. Backgrounds and colours are printed.",
            "default": "A4"
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "true = tell the site the visitor prefers a dark colour scheme (prefers-color-scheme: dark). Sites without a dark theme look the same.",
            "default": false
          },
          "timeoutSecs": {
            "title": "Timeout per URL (seconds)",
            "minimum": 10,
            "maximum": 180,
            "type": "integer",
            "description": "Give up on a URL after this many seconds, e.g. 60 for slow sites. A URL that times out is retried once, then reported as failed and not charged; the other URLs carry on.",
            "default": 45
          },
          "maxConcurrency": {
            "title": "Pages at the same time",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "How many pages are captured in parallel, e.g. 8. About 8 screen-size pages fit in the 4 GB default memory; full-page and PDF runs use at most 5 at a time, because long pages need much more memory.",
            "default": 8
          },
          "incremental": {
            "title": "Only changed since last run",
            "type": "boolean",
            "description": "true = save and charge only screenshots that differ from the last run's screenshot of the same URL with the same settings (the first run returns everything). Every result also has changed: true / false / null either way. Use with a schedule for visual change monitoring.",
            "default": false
          },
          "trackingId": {
            "title": "Change-tracking name",
            "type": "string",
            "description": "Separate change history per name, e.g. 'competitors-weekly', so two schedules of the same URLs do not share 'last run'. Leave as 'default' for one history per account.",
            "default": "default"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}