Website to PDF API Reference

API Overview

Website to PDF is a simple tool for converting a website to PDF. It returns the PDF file generated from the website.

To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.

View API in Directory

Convert Website to PDF

10 Token

Convert a website to a PDF file

	
#POST Request
https://api.apiverve.com/v1/websitetopdf	

	
					

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml


urlstring(required)

The URL of the website to convert to PDF

marginTopdouble

The top margin of the PDF in inches (e.g., 0.4)

marginRightdouble

The right margin of the PDF in inches (e.g., 0.4)

marginBottomdouble

The bottom margin of the PDF in inches (e.g., 0.4)

marginLeftdouble

The left margin of the PDF in inches (e.g., 0.4)


Sample Request
	
import requests

url = "https://api.apiverve.com/v1/websitetopdf"

payload = { "marginTop": 0.4, "marginBottom": 0.4, "marginLeft": 0.4, "marginRight": 0.4, "landscape": false, "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts" }
headers = {
	"x-api-key": "YOUR_API_KEY",
	"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
	
							
	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Post,
	RequestUri = new Uri("https://api.apiverve.com/v1/websitetopdf"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
	Content = new StringContent("{ \"marginTop\": 0.4, \"marginBottom\": 0.4, \"marginLeft\": 0.4, \"marginRight\": 0.4, \"landscape\": false, \"url\": \"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts\" }")
	{
		Headers =
		{
			ContentType = new MediaTypeHeaderValue("application/json")
		}
	}
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}
	
							
	
const data = JSON.stringify({ "marginTop": 0.4, "marginBottom": 0.4, "marginLeft": 0.4, "marginRight": 0.4, "landscape": false, "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts" });

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('POST', 'https://api.apiverve.com/v1/websitetopdf');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);
	
							
	
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://api.apiverve.com/v1/websitetopdf',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json'
  },
  body: { "marginTop": 0.4, "marginBottom": 0.4, "marginLeft": 0.4, "marginRight": 0.4, "landscape": false, "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts" },
  json: true
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});
	
							
	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/websitetopdf"))
		.header("x-api-key", "YOUR_API_KEY")
		.header("Content-Type", "application/json")
		.header("Accept", "application/json")
		.method("POST", HttpRequest.BodyPublishers.ofString("{ \"marginTop\": 0.4, \"marginBottom\": 0.4, \"marginLeft\": 0.4, \"marginRight\": 0.4, \"landscape\": false, \"url\": \"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts\" }"))
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
	
							
	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY",
	"Content-Type": "application/json"
]
let parameters = ["marginTop" : 0.4, "marginBottom" : 0.4, "marginLeft" : 0.4, "marginRight" : 0.4, "landscape" : False, "url" : "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts",] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/websitetopdf")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()
	
							
	
curl --request POST \
	--url https://api.apiverve.com/v1/websitetopdf \
	--header 'Accept: application/json' \
	--header 'Content-Type: application/json' \
	--header 'x-api-key: YOUR_API_KEY' \
	--data '{ "marginTop": 0.4, "marginBottom": 0.4, "marginLeft": 0.4, "marginRight": 0.4, "landscape": false, "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts" }'
	
							

Sample Response
	
{
  "status": "ok",
  "error": null,
  "data": {
    "marginLeft": "0.4in",
    "marginRight": "0.4in",
    "marginTop": "0.4in",
    "marginBottom": "0.4in",
    "landscape": false,
    "pdfName": "75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf",
    "expires": 1740260149292,
    "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts",
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1740260149&Signature=GSNCajtyCCkRJEd2n%2FEJ7z6a6E5oa3VmeK5Qkk9P3uYEAFsz4xVNnqZpZ4LDPJhKY9ea8ii1jNX5iKQabiTikwz%2Bg9g1kTxB5572oFPnsWAiaCreKeim3MzuczZRXtLnKpoCEMZWf6aGbYn7kRfKc47tFFbicx74isqxx6Lzs%2BMjKa3k33NUxH9JjQYeStWtnvI9DZorXgpUvjH8QL2H%2FU8wpZSIgpZAY8LMBo07PfWAO2ulinprBnTGhqIErIs71E6CPXnYuRo8r2ZOenQKkTsYNPXXt8vRK9eBh70dBVMEjfYQQA5tyauKvBNdpAmG3DLiKLATut55aKeicioejA%3D%3D"
  },
  "code": 200
}
	
							
	
<Root>
  <status>ok</status>
  <error />
  <data>
    <marginLeft>0.4in</marginLeft>
    <marginRight>0.4in</marginRight>
    <marginTop>0.4in</marginTop>
    <marginBottom>0.4in</marginBottom>
    <landscape>false</landscape>
    <pdfName>75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf</pdfName>
    <expires>1740260149292</expires>
    <url>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts</url>
    <downloadURL>https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&amp;Expires=1740260149&amp;Signature=GSNCajtyCCkRJEd2n%2FEJ7z6a6E5oa3VmeK5Qkk9P3uYEAFsz4xVNnqZpZ4LDPJhKY9ea8ii1jNX5iKQabiTikwz%2Bg9g1kTxB5572oFPnsWAiaCreKeim3MzuczZRXtLnKpoCEMZWf6aGbYn7kRfKc47tFFbicx74isqxx6Lzs%2BMjKa3k33NUxH9JjQYeStWtnvI9DZorXgpUvjH8QL2H%2FU8wpZSIgpZAY8LMBo07PfWAO2ulinprBnTGhqIErIs71E6CPXnYuRo8r2ZOenQKkTsYNPXXt8vRK9eBh70dBVMEjfYQQA5tyauKvBNdpAmG3DLiKLATut55aKeicioejA%3D%3D</downloadURL>
  </data>
  <code>200</code>
</Root>
	
							
	
status: ok
error: 
data:
  marginLeft: 0.4in
  marginRight: 0.4in
  marginTop: 0.4in
  marginBottom: 0.4in
  landscape: false
  pdfName: 75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf
  expires: 1740260149292
  url: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts
  downloadURL: https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1740260149&Signature=GSNCajtyCCkRJEd2n%2FEJ7z6a6E5oa3VmeK5Qkk9P3uYEAFsz4xVNnqZpZ4LDPJhKY9ea8ii1jNX5iKQabiTikwz%2Bg9g1kTxB5572oFPnsWAiaCreKeim3MzuczZRXtLnKpoCEMZWf6aGbYn7kRfKc47tFFbicx74isqxx6Lzs%2BMjKa3k33NUxH9JjQYeStWtnvI9DZorXgpUvjH8QL2H%2FU8wpZSIgpZAY8LMBo07PfWAO2ulinprBnTGhqIErIs71E6CPXnYuRo8r2ZOenQKkTsYNPXXt8vRK9eBh70dBVMEjfYQQA5tyauKvBNdpAmG3DLiKLATut55aKeicioejA%3D%3D
code: 200
	
							
	
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "error": {},
    "data": {
      "$ref": "#/definitions/Data"
    },
    "code": {
      "type": "integer"
    }
  },
  "definitions": {
    "Data": {
      "type": "object",
      "properties": {
        "marginLeft": {
          "type": "string"
        },
        "marginRight": {
          "type": "string"
        },
        "marginTop": {
          "type": "string"
        },
        "marginBottom": {
          "type": "string"
        },
        "landscape": {
          "type": "boolean"
        },
        "pdfName": {
          "type": "string"
        },
        "expires": {
          "type": "integer"
        },
        "url": {
          "type": "string"
        },
        "downloadURL": {
          "type": "string"
        }
      }
    }
  }
}
	
							
Live Test API in Playground

OpenAPI Schema

                                    
openapi: 3.0.4
info:
  title: APIVerve
  description: Unleash the potential of your applications with a single API Key and access to various APIs
  termsOfService: https://apiverve.com/terms/
  contact:
    name: APIVerve Support
    email: [email protected]
    url: https://apiverve.com/contact
  version: 1.0.9
externalDocs:
  description: Learn more about APIVerve
  url: https://docs.apiverve.com?utm_source=openapi
servers:
- url: https://api.apiverve.com/
paths:
  /v1/websitetopdf:
    post:
      summary: Convert Website to PDF
      description: Website to PDF is a simple tool for converting a website to PDF. It returns the PDF file generated from the website.
      operationId: websitetopdf
      parameters:
      - name: body
        in: body
        description: Request body parameter
        required: true
        schema:
          type: object
          properties:
            url:
              type: string
              description: The URL of the website to convert to PDF
              example: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts
            marginTop:
              type: number
              description: The top margin of the PDF in inches (e.g., 0.4)
              default: '0.4'
              example: 0.4
            marginRight:
              type: number
              description: The right margin of the PDF in inches (e.g., 0.4)
              default: '0.4'
              example: 0.4
            marginBottom:
              type: number
              description: The bottom margin of the PDF in inches (e.g., 0.4)
              default: '0.4'
              example: 0.4
            marginLeft:
              type: number
              description: The left margin of the PDF in inches (e.g., 0.4)
              default: '0.4'
              example: 0.4
          required:
          - url
          example:
            marginTop: 0.4
            marginBottom: 0.4
            marginLeft: 0.4
            marginRight: 0.4
            landscape: false
            url: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: status
                  error:
                    type: string
                    description: error
                  data:
                    type: string
                    description: data
                  code:
                    type: number
                    description: code
              example:
                status: ok
                error: 
                data:
                  marginLeft: 0.4in
                  marginRight: 0.4in
                  marginTop: 0.4in
                  marginBottom: 0.4in
                  landscape: false
                  pdfName: 75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf
                  expires: 1740260149292
                  url: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts
                  downloadURL: https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/75a31d2a-c96d-428d-9c1e-63795d54f74c.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1740260149&Signature=GSNCajtyCCkRJEd2n%2FEJ7z6a6E5oa3VmeK5Qkk9P3uYEAFsz4xVNnqZpZ4LDPJhKY9ea8ii1jNX5iKQabiTikwz%2Bg9g1kTxB5572oFPnsWAiaCreKeim3MzuczZRXtLnKpoCEMZWf6aGbYn7kRfKc47tFFbicx74isqxx6Lzs%2BMjKa3k33NUxH9JjQYeStWtnvI9DZorXgpUvjH8QL2H%2FU8wpZSIgpZAY8LMBo07PfWAO2ulinprBnTGhqIErIs71E6CPXnYuRo8r2ZOenQKkTsYNPXXt8vRK9eBh70dBVMEjfYQQA5tyauKvBNdpAmG3DLiKLATut55aKeicioejA%3D%3D
                code: 200
        '401':
          description: Your request was not authorized, or your API Key was invalid
        '404':
          description: Requested resource was not found
        '500':
          description: A server error has occured, try again later
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
security:
- api_key: []
                                    
                                
Live Test API in Playground

Client Libraries

To get started with minimal code, most of our APIs are available through client libraries and clients:

run in postman button npm logo pypi logo nuget logo swagger logo

Response Types

The Website to PDF API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

Authentication

The Website to PDF API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

Error Code Meaning
401 Your request was made with invalid credentials. This error also appears when you don't pass the x-api-key header in your request.

Rate Limits

	
{
    "status": "error",
    "data": null,
    "error": "tokens have been depleted",
    "code": 429
}
	
							

Each subscription has its own monthly token limit. Your token count is based on your subscription plan. If you reach your limits, don't worry. You can always upgrade or downgrade at any time. View Pricing

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a detailed JSON.

The Website to PDF API uses the following error code:

Error Code Meaning
429 You have exceeded your rate limit and further requests will be denied until the next cycle.

Error Codes

For reference, the Website to PDF API uses the following error codes:

Error Code Meaning
Code Message
200 The request was successful. The response will include the requested data.
400 The request was invalid. The response will include a message that explains the error.
401 The request was not authorized. Usually, this means that the API key is missing or invalid.
403 This means that the request was trying to access a resource that it does not have permission to access.
404 This means that the resource you are trying to access does not exist.
429 This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request.
500 This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible.
ON THIS PAGE