Name: HTML to PDF and Website Screenshot API: PNG, JPEG, PDF
Brand: rasareka
SKU: api-rasareka-pdf-screenshot
Availability: InStock
Author: API Market

Khairul Fauzy Khairudin

# PDF & Screenshot API

## Overview

The PDF & Screenshot API renders web pages with a real Chromium browser. It turns any public URL, or HTML you send, into a PDF with paper size, margins, headers and footers with page numbers, or into a PNG, JPEG or WebP screenshot of the viewport, the full page or a single element. Pages can be cleaned up before capture by hiding cookie banners, waiting for an element or adding a delay, and every result can come back as the file itself or as a base64 data URI in JSON.

It is built for developers who generate invoices, reports, tickets and receipts as PDFs, and for monitoring, archiving, social preview and testing tools that need website screenshots. In our tests an HTML invoice with a page number footer came back as a 19 KB PDF in 3.8 seconds, `https://example.com` as a 1280 by 800 PNG in 4 seconds, and a full-page capture of a long Wikipedia article as a 3.4 MB PNG in 9 seconds.

## Features

*   **4 endpoints**: screenshot and PDF, each from a URL (GET) or from your HTML (POST).
*   **Real Chromium**: modern CSS, web fonts and JavaScript render as in a browser.
*   **PDF layout**: paper size, orientation, margins, scale, page ranges, and header and footer HTML with page numbers.
*   **Screenshot control**: PNG, JPEG or WebP, full page, element capture, retina scale, dark mode and transparency.
*   **Page clean-up**: hide selectors, wait for a selector or add a delay before capture.
*   **Rate limit**: 10 requests per second on every plan.

## Use Cases

*   **Invoices and receipts**: render HTML templates to PDF on demand.
*   **Reports**: export dashboards and reports as PDFs.
*   **Website monitoring**: capture pages on a schedule to spot changes.
*   **Social previews**: generate images of pages for sharing.
*   **Archiving**: keep PDF or image copies of web pages.

## API Documentation

### Base URL

All requests use the following base URL.

```
https://prod.api.market/api/v1/rasareka/pdf-screenshot
```

### Authentication

All requests are authenticated with the `x-api-market-key` header.

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. Screenshot a URL

Captures a public URL as an image.

**Method:** `GET`

**Endpoint:** `/render/v1/screenshot`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `url` | query | Public http(s) URL to capture | string | Yes | - | - |
| `format` | query | `png`, `jpeg` or `webp` | string | No | `png` | - |
| `width` | query | Viewport width in pixels | integer | No | - | - |
| `height` | query | Viewport height in pixels | integer | No | - | - |
| `full_page` | query | Capture the whole scrollable page | boolean | No | `false` | - |
| `selector` | query | Capture only this CSS selector | string | No | - | - |
| `scale_factor` | query | Device scale factor for retina images | number | No | `1` | 3 |
| `quality` | query | JPEG or WebP quality | integer | No | - | 100 |
| `delay` | query | Milliseconds to wait after load | integer | No | `0` | 10000 |
| `wait_for_selector` | query | Wait until this CSS selector appears | string | No | - | - |
| `hide_selectors` | query | CSS selectors to hide, such as cookie banners | string | No | - | - |
| `dark_mode` | query | Render with a dark colour scheme | boolean | No | `false` | - |
| `transparent` | query | Transparent background (PNG and WebP) | boolean | No | `false` | - |
| `response` | query | Set `json` to get a base64 data URI instead of the image | string | No | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/rasareka/pdf-screenshot/render/v1/screenshot?url=https%3A%2F%2Fexample.com&format=png&width=1280&height=800' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

The body is the image itself (`image/png` here, about 75 KB). With `response=json` the image comes back in JSON instead:

```json
{
  "mime_type": "image/jpeg",
  "size_bytes": 69069,
  "source_status": 200,
  "data_uri": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABA..."
}
```

The `data_uri` value above is shortened. A URL that is not public http(s) returns 400:

```json
{
  "error": "invalid_parameter",
  "message": "Only public http(s) URLs are allowed"
}
```

#### 2. Screenshot your HTML

Renders HTML you send, or a URL, and captures it as an image. Takes the same options as the GET call in a JSON body, plus `html`.

**Method:** `POST`

**Endpoint:** `/render/v1/screenshot`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `html` | body | HTML to render. Send `html` or `url`. | string | No | - | - |
| `format` | body | `png`, `jpeg` or `webp` | string | No | `png` | - |
| `width` | body | Viewport width in pixels | integer | No | - | - |
| `height` | body | Viewport height in pixels | integer | No | - | - |
| `full_page` | body | Capture the whole scrollable page | boolean | No | `false` | - |
| `selector` | body | Capture only this CSS selector | string | No | - | - |
| `scale_factor` | body | Device scale factor for retina images | number | No | `1` | 3 |
| `quality` | body | JPEG or WebP quality | integer | No | - | 100 |
| `delay` | body | Milliseconds to wait after load | integer | No | `0` | 10000 |
| `wait_for_selector` | body | Wait until this CSS selector appears | string | No | - | - |
| `hide_selectors` | body | CSS selectors to hide, such as cookie banners | string | No | - | - |
| `dark_mode` | body | Render with a dark colour scheme | boolean | No | `false` | - |
| `transparent` | body | Transparent background (PNG and WebP) | boolean | No | `false` | - |
| `response` | body | Set `json` to get a base64 data URI instead of the image | string | No | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/rasareka/pdf-screenshot/render/v1/screenshot' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"html": "<h1 style='font-family:sans-serif'>Hello</h1>", "width": 800, "height": 400, "format": "png"}'
```

**Example Response (200 OK):**

The body is the image itself (`image/png`, about 3 KB for this call).

#### 3. Render a URL to PDF

Prints a public URL to PDF.

**Method:** `GET`

**Endpoint:** `/render/v1/pdf`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `url` | query | Public http(s) URL to render | string | Yes | - | - |
| `paper` | query | `A3`, `A4`, `A5`, `Letter`, `Legal` or `Tabloid` | string | No | `A4` | - |
| `landscape` | query | Landscape orientation | boolean | No | `false` | - |
| `margin` | query | Page margin, for example `10mm` or `0.5in` | string | No | - | - |
| `print_background` | query | Print background colours and images | boolean | No | - | - |
| `scale` | query | Rendering scale | number | No | `1` | - |
| `page_ranges` | query | Pages to keep, for example `1-3` | string | No | all | - |
| `hide_selectors` | query | CSS selectors to hide | string | No | - | - |
| `download` | query | Send as an attachment | boolean | No | `false` | - |
| `filename` | query | File name for the download | string | No | - | - |
| `response` | query | Set `json` to get a base64 data URI instead of the file | string | No | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/rasareka/pdf-screenshot/render/v1/pdf?url=https%3A%2F%2Fexample.com&paper=A4' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

The body is the PDF file (`application/pdf`, about 88 KB for this call).

#### 4. Render your HTML to PDF

Prints HTML you send to PDF, with optional header and footer templates. Use `pageNumber` and `totalPages` classes for page numbers.

**Method:** `POST`

**Endpoint:** `/render/v1/pdf`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `html` | body | HTML document to print | string | Yes | - | - |
| `header_html` | body | HTML template for the page header | string | No | - | - |
| `footer_html` | body | HTML template for the page footer | string | No | - | - |
| `paper` | body | `A3`, `A4`, `A5`, `Letter`, `Legal` or `Tabloid` | string | No | `A4` | - |
| `landscape` | body | Landscape orientation | boolean | No | `false` | - |
| `margin` | body | Page margin, for example `10mm` or `0.5in` | string | No | - | - |
| `print_background` | body | Print background colours and images | boolean | No | - | - |
| `scale` | body | Rendering scale | number | No | `1` | - |
| `page_ranges` | body | Pages to keep, for example `1-3` | string | No | all | - |
| `hide_selectors` | body | CSS selectors to hide | string | No | - | - |
| `download` | body | Send as an attachment | boolean | No | `false` | - |
| `filename` | body | File name for the download | string | No | - | - |
| `response` | body | Set `json` to get a base64 data URI instead of the file | string | No | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/rasareka/pdf-screenshot/render/v1/pdf' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"html": "<h1>Invoice #1001</h1><p>Total: $49</p>", "paper": "A4", "margin": "15mm", "footer_html": "<div style='font-size:9px;width:100%;text-align:center'>Page <span class='pageNumber'></span> of <span class='totalPages'></span></div>"}'
```

**Example Response (200 OK):**

The body is the PDF file (`application/pdf`, about 19 KB for this call), with "Page 1 of 1" in the footer.

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The request succeeded and the JSON result is in the response body. |
| 400 | Bad Request | A parameter is missing or invalid, for example `Only public http(s) URLs are allowed`. |
| 401 | Unauthorized | The `x-api-market-key` header is missing or the key is not valid. |
| 403 | Forbidden | Your key does not have an active subscription that includes this endpoint. |
| 404 | Not Found | The path does not match an endpoint of this API. Check the Base URL and path. |
| 429 | Too Many Requests | You went over 10 requests per second or used up the quota of your plan. |
| 500 | Internal Server Error | The request failed on the server. Retry once, then contact us if it continues. |
| 503 | Service Unavailable | The service is temporarily unavailable. Retry after a short wait. |

## Rate Limits

Every plan allows up to 10 requests per second, and each subscription plan has its own monthly quota. When you go over a limit, the API returns `429 Too Many Requests`. Throttle your requests, back off before retrying, and honour the `Retry-After` header when it is present.

## FAQ

*   **Can it capture pages behind a login?**
    No. Only public http(s) URLs are allowed. To capture private content, send the HTML in a POST call instead.

*   **How do I add page numbers to a PDF?**
    Put elements with the classes `pageNumber` and `totalPages` in `footer_html` or `header_html`.

*   **How do I hide a cookie banner?**
    Pass its CSS selector in `hide_selectors`.

*   **How long does a render take?**
    Our test renders took 3 to 5 seconds, and a full-page capture of a long article about 9 seconds. Set your client timeout to at least 30 seconds.

## Contact Us

If you have any questions or need support, reach out through the chat embedded on this page or email us at hello@magicapi.com.


Render any URL or your own HTML to PDF, or capture full-page PNG, JPEG and WebP screenshots with real Chromium. Headers, footers and dark mode.

HTML to PDF and Website Screenshot API: PNG, JPEG, PDF