{
  "openapi": "3.0.1",
  "info": {
    "title": "Bulk Website Screenshots: Full Page, PDF, No Cookie Banners",
    "description": "Screenshot a list of URLs or call it as an instant API: full-page or viewport, PNG, JPEG, WebP or PDF, desktop, tablet or mobile, dark mode. Cookie banners and ads hidden. $0.75 per 1,000 screenshots ($0.52 on Business) + usage. No screenshot fee for failed pages.",
    "version": "0.1",
    "x-build-id": "UZg99tadG2mqMGjk1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/opendata-tools~bulk-website-screenshots/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-opendata-tools-bulk-website-screenshots",
        "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/opendata-tools~bulk-website-screenshots/runs": {
      "post": {
        "operationId": "runs-sync-opendata-tools-bulk-website-screenshots",
        "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/opendata-tools~bulk-website-screenshots/run-sync": {
      "post": {
        "operationId": "run-sync-opendata-tools-bulk-website-screenshots",
        "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": [
          "startUrls"
        ],
        "properties": {
          "startUrls": {
            "title": "URLs to capture",
            "type": "array",
            "description": "Pages to screenshot. Bare domains like example.com get https:// added. Duplicates are captured once.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "format": {
            "title": "Format",
            "enum": [
              "png",
              "jpeg",
              "webp",
              "pdf"
            ],
            "type": "string",
            "description": "File type for each capture. PNGs over 9 MB are saved as JPEG instead (noted in the row).",
            "default": "png"
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the whole page from top to bottom (scrolling first so lazy-loaded images appear). Off = only the first screen.",
            "default": true
          },
          "device": {
            "title": "Device",
            "enum": [
              "desktop",
              "desktop-hd",
              "desktop-retina",
              "laptop",
              "tablet",
              "mobile",
              "iphone",
              "android"
            ],
            "type": "string",
            "description": "Screen size, pixel density and browser identity used to load each page.",
            "default": "desktop"
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners",
            "type": "boolean",
            "description": "Hides consent pop-ups from the common providers (OneTrust, Cookiebot, Usercentrics, Quantcast, Didomi and more) and unlocks pages they freeze. Nothing is clicked or accepted.",
            "default": true
          },
          "hidePopups": {
            "title": "Hide other pop-ups",
            "type": "boolean",
            "description": "Hides sign-up, newsletter, donation, app and \"turn off your ad blocker\" pop-ups that cover the page. Turn off if you need to capture a page's own pop-up.",
            "default": true
          },
          "blockAds": {
            "title": "Block ads",
            "type": "boolean",
            "description": "Stops requests to well-known ad networks and hides common ad slots.",
            "default": true
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Tells the site the visitor prefers dark mode. Only sites that support it will change.",
            "default": false
          },
          "transparentBackground": {
            "title": "Transparent background",
            "type": "boolean",
            "description": "PNG and WebP only: pages that don't set their own background come out see-through, handy for logos and widgets.",
            "default": false
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "domcontentloaded",
              "load",
              "networkidle"
            ],
            "type": "string",
            "description": "How long to wait before capturing. Pages that never finish loading are still captured once the wait runs out.",
            "default": "load"
          },
          "delaySecs": {
            "title": "Extra delay (seconds)",
            "minimum": 0,
            "maximum": 30,
            "type": "integer",
            "description": "Optional pause after loading, for animations or content that appears late. Visible images are always waited for.",
            "default": 0
          },
          "maxPageHeight": {
            "title": "Max page height (px)",
            "minimum": 500,
            "maximum": 30000,
            "type": "integer",
            "description": "Very long pages are cut off at this height (the row shows truncated: true). WebP is limited to 16,383 pixels tall.",
            "default": 15000
          },
          "quality": {
            "title": "JPEG/WebP quality",
            "minimum": 10,
            "maximum": 100,
            "type": "integer",
            "description": "Higher is sharper but bigger. Ignored for PNG and PDF.",
            "default": 80
          },
          "selector": {
            "title": "Only capture this element (CSS selector)",
            "type": "string",
            "description": "Optional. Capture just the first matching element, e.g. #pricing or main. Pages without a match are marked failed (no screenshot fee)."
          },
          "waitForSelector": {
            "title": "Wait for this element (CSS selector)",
            "type": "string",
            "description": "Optional. Wait until an element matching this selector is visible before capturing, e.g. #results or .price. If it never appears, the page is marked failed (no screenshot fee)."
          },
          "hideSelectors": {
            "title": "Also hide these elements (CSS selectors)",
            "type": "array",
            "description": "Optional. Extra things to hide before capturing, e.g. .chat-widget or #newsletter-popup.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "viewportWidth": {
            "title": "Custom width (px)",
            "minimum": 200,
            "maximum": 3840,
            "type": "integer",
            "description": "Optional. Overrides the device's screen width."
          },
          "viewportHeight": {
            "title": "Custom height (px)",
            "minimum": 200,
            "maximum": 2160,
            "type": "integer",
            "description": "Optional. Overrides the device's screen height (the size of a non-full-page capture)."
          },
          "pageTimeoutSecs": {
            "title": "Time limit per page (seconds)",
            "minimum": 15,
            "maximum": 180,
            "type": "integer",
            "description": "Time limit for loading each page. A page still loading at the limit is captured as it is, with the note 'captured before the page finished loading'. A page that sends nothing in time is marked failed (no screenshot fee, though time spent counts as usage) and is not tried again. Raise it for very slow sites.",
            "default": 25
          },
          "maxConcurrency": {
            "title": "Pages at once",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Optional. By default this is set from the run's memory: 3 pages per 4 GB (Apify gives one processor core per 4 GB). More memory means faster runs."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}