# Page Printer (`marco.gullo/page-printer`) Actor

Performs screenshots or print web pages in PDF format.

- **URL**: https://apify.com/marco.gullo/page-printer.md
- **Developed by:** [Marco Gullo](https://apify.com/marco.gullo) (community)
- **Categories:** Developer tools, Integrations
- **Stats:** 76 total users, 4 monthly users, 94.7% runs succeeded, 3 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Page printer

### Tips and tricks

#### Pre-function

You can execute arbitrary code before performing a screenshot, passing a function which takes as input the [Playwright Crawling Context](https://crawlee.dev/api/playwright-crawler/interface/PlaywrightCrawlingContext).

You can also register information which will be written to the output Dataset, writing into the record with the key `notes` in the `userData`.

Example:

```js
const preFunction = async (context) => {
    const { request, page } = context;
    const { userData } = request;
    const { notes } = userData;

    // Perform some operation in the page
    await page.selector('...').click();

    if (page.selector('...').isVisible) {
        notes.isElementVisible = true;
    } else {
        notes.isElementVisible = false;
    }
}
````

Output data:

```json
[
    {
        "url": "https://...",
        "fileUrl": "...",
        "fileKey": "...",
        "notes": {
            "isElementVisible": true
        }
    },
    {
        "url": "https://...",
        "fileUrl": "...",
        "fileKey": "...",
        "notes": {
            "isElementVisible": false
        }
    }
]
```

### Contributing

#### Input schema

Edit input schema in `src-schemas`.
You can use any JSON schema option, not just the ones from Apify specifications.

Install [apify-schema-tools](https://www.npmjs.com/package/apify-schema-tools) globally and run:

```sh
npx generate-apify-type --input && npx generate-apify-schema --input
```

# Actor input Schema

## `startUrls` (type: `array`):

URLs to start with.

## `method` (type: `string`):

Method for generating the page print.

## `width` (type: `integer`):

The page width to apply: affects the screenshot.

## `height` (type: `integer`):

The page height to apply: can affect the screenshot.

## `loadCookiesExtension` (type: `boolean`):

Hide cookies using browser extension "I don't care about cookies", version 3.5.1

## `loadPopupsExtension` (type: `boolean`):

Hide popups using browser extension "PopUpOFF", version 2.1.3

## `waitForLoadState` (type: `string`):

The state to load for before processing the page.

## `preFunction` (type: `string`):

Function to evaluate before printing the page. Can accept Playwright's 'page' object as input.

## `alwaysScreenshot` (type: `boolean`):

Try to take a screenshot even if the pre-function crashed

## `screenshotFormat` (type: `string`):

Which image format to use for the screenshot.

## `screenshotQuality` (type: `integer`):

The JPEG quality for the screenshot, which is always stored.

## `fullPageScreenshot` (type: `boolean`):

Take a full page screenshot, increasing the LLM cost in "screenshot" mode. Can be turned off if all the information is in the viewport. Sending just the viewport, can also increase the LLM's success rate.

## `pdfMedia` (type: `string`):

Media for printing PDF. See: https://playwright.dev/docs/api/class-page#page-pdf.

## `maxRequestRetries` (type: `integer`):

Max number of retries before declaring a screenshot job failed.

## `waitForLoadStateTimeout` (type: `integer`):

timeout for waitForLoadState event, in milliseconds

## `requestHandlerTimeoutSecs` (type: `integer`):

Timeout in which the requestHandler function needs to finish, in seconds.

## `navigationTimeoutSecs` (type: `integer`):

Timeout in which page navigation needs to finish, in seconds.

## `proxyOptions` (type: `object`):

Select proxies to be used by your crawler.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://crawlee.dev"
    }
  ],
  "method": "screenshot",
  "width": 1280,
  "height": 800,
  "screenshotFormat": "png",
  "screenshotQuality": 100,
  "fullPageScreenshot": true,
  "pdfMedia": "print",
  "proxyOptions": {
    "useApifyProxy": true
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        {
            "url": "https://crawlee.dev"
        }
    ],
    "loadCookiesExtension": false,
    "loadPopupsExtension": false,
    "proxyOptions": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("marco.gullo/page-printer").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "startUrls": [{ "url": "https://crawlee.dev" }],
    "loadCookiesExtension": False,
    "loadPopupsExtension": False,
    "proxyOptions": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("marco.gullo/page-printer").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    {
      "url": "https://crawlee.dev"
    }
  ],
  "loadCookiesExtension": false,
  "loadPopupsExtension": false,
  "proxyOptions": {
    "useApifyProxy": true
  }
}' |
apify call marco.gullo/page-printer --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=marco.gullo/page-printer",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Page Printer",
        "description": "Performs screenshots or print web pages in PDF format.",
        "version": "0.0",
        "x-build-id": "cP7nZcTzDnJDZxKbJ"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/marco.gullo~page-printer/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-marco.gullo-page-printer",
                "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/marco.gullo~page-printer/runs": {
            "post": {
                "operationId": "runs-sync-marco.gullo-page-printer",
                "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/marco.gullo~page-printer/run-sync": {
            "post": {
                "operationId": "run-sync-marco.gullo-page-printer",
                "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",
                    "method"
                ],
                "properties": {
                    "startUrls": {
                        "title": "Start URLs",
                        "type": "array",
                        "description": "URLs to start with.",
                        "items": {
                            "type": "object",
                            "required": [
                                "url"
                            ],
                            "properties": {
                                "url": {
                                    "type": "string",
                                    "title": "URL of a web page",
                                    "format": "uri"
                                }
                            }
                        }
                    },
                    "method": {
                        "title": "Method",
                        "enum": [
                            "screenshot",
                            "pdf"
                        ],
                        "type": "string",
                        "description": "Method for generating the page print.",
                        "default": "screenshot"
                    },
                    "width": {
                        "title": "Page width",
                        "minimum": 0,
                        "type": "integer",
                        "description": "The page width to apply: affects the screenshot.",
                        "default": 1280
                    },
                    "height": {
                        "title": "Page height",
                        "minimum": 0,
                        "type": "integer",
                        "description": "The page height to apply: can affect the screenshot.",
                        "default": 800
                    },
                    "loadCookiesExtension": {
                        "title": "Load Cookies extension",
                        "type": "boolean",
                        "description": "Hide cookies using browser extension \"I don't care about cookies\", version 3.5.1"
                    },
                    "loadPopupsExtension": {
                        "title": "Load Popups extension",
                        "type": "boolean",
                        "description": "Hide popups using browser extension \"PopUpOFF\", version 2.1.3"
                    },
                    "waitForLoadState": {
                        "title": "Wait for load state",
                        "enum": [
                            "load",
                            "domcontentloaded",
                            "networkidle"
                        ],
                        "type": "string",
                        "description": "The state to load for before processing the page."
                    },
                    "preFunction": {
                        "title": "Pre-function",
                        "type": "string",
                        "description": "Function to evaluate before printing the page. Can accept Playwright's 'page' object as input."
                    },
                    "alwaysScreenshot": {
                        "title": "Always take a screenshot",
                        "type": "boolean",
                        "description": "Try to take a screenshot even if the pre-function crashed"
                    },
                    "screenshotFormat": {
                        "title": "Screenshot format",
                        "enum": [
                            "jpeg",
                            "png"
                        ],
                        "type": "string",
                        "description": "Which image format to use for the screenshot.",
                        "default": "png"
                    },
                    "screenshotQuality": {
                        "title": "Screenshot quality",
                        "minimum": 0,
                        "maximum": 100,
                        "type": "integer",
                        "description": "The JPEG quality for the screenshot, which is always stored.",
                        "default": 100
                    },
                    "fullPageScreenshot": {
                        "title": "Full page screenshot",
                        "type": "boolean",
                        "description": "Take a full page screenshot, increasing the LLM cost in \"screenshot\" mode. Can be turned off if all the information is in the viewport. Sending just the viewport, can also increase the LLM's success rate.",
                        "default": true
                    },
                    "pdfMedia": {
                        "title": "Media",
                        "enum": [
                            "print",
                            "screen"
                        ],
                        "type": "string",
                        "description": "Media for printing PDF. See: https://playwright.dev/docs/api/class-page#page-pdf.",
                        "default": "print"
                    },
                    "maxRequestRetries": {
                        "title": "Max request retries",
                        "type": "integer",
                        "description": "Max number of retries before declaring a screenshot job failed."
                    },
                    "waitForLoadStateTimeout": {
                        "title": "wait For Load State Timeout (milliseconds)",
                        "type": "integer",
                        "description": " timeout for waitForLoadState event, in milliseconds"
                    },
                    "requestHandlerTimeoutSecs": {
                        "title": "request Handler Timeout Secs",
                        "type": "integer",
                        "description": "Timeout in which the requestHandler function needs to finish, in seconds."
                    },
                    "navigationTimeoutSecs": {
                        "title": "Navigation Timeout Secs",
                        "type": "integer",
                        "description": "Timeout in which page navigation needs to finish, in seconds."
                    },
                    "proxyOptions": {
                        "title": "Proxy configuration",
                        "type": "object",
                        "description": "Select proxies to be used by your crawler."
                    }
                }
            },
            "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
