Website to PDF API
Overview
To use Website to PDF, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/websitetopdfExample
How to call the Website to PDF API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/websitetopdf" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"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 response = await fetch('https://api.apiverve.com/v1/websitetopdf', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: 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 data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
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"
}
response = requests.post('https://api.apiverve.com/v1/websitetopdf', headers=headers, json=payload)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"marginTop": "0.4",
"marginBottom": "0.4",
"marginLeft": "0.4",
"marginRight": "0.4",
"landscape": "false",
"url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/websitetopdf", bytes.NewBuffer(jsonPayload))
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}{
"status": "ok",
"error": null,
"data": {
"marginLeft": "0.4in",
"marginRight": "0.4in",
"marginTop": "0.4in",
"marginBottom": "0.4in",
"landscape": false,
"pdfName": "128deceb-c515-444b-8863-82cb3f6ba632.pdf",
"expires": 1766097122116,
"url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts",
"downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/128deceb-c515-444b-8863-82cb3f6ba632.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766097122&Signature=LI747FKqKj5i5TYX3KIoVy%2FHgXsLOSXfVEUM0Ekqz2SiiYOZWuk3Of7QBDUklSrcbjiHV0AjbzFTKt6oDU83UkN282HbmhxwrolN6v1Zb9twVi1y7gmTpapCiJi%2BpA1r89ioe%2Fe0%2FV7KrIWaqsorzpdJrnMqe2izMWBaZq%2FYkSO2qlwSyhg2R8EsfxYNAANtd%2FuNS0RuIzqTdhNCiTrRirnDAKS3dMCySQJRznHFnyqzNj1OXwVjvdpSMn9XhWCUa%2FDRR8q%2BE9B0yF8eTvIrDSe2OzJT%2FJLc9rxcLfXAny21gtNqrzMJPU4yM9Ge%2BEbepmDnNZf9xpODNsnq5eLF0g%3D%3D"
}
}Authentication
The Website to PDF API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Website to PDF API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Website to PDF API:
Convert Website to PDF
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
url | string | required | The URL of the website to convert to PDF Format: url (e.g., https://en.wikipedia.org/wiki/PDF) | - | |
marginTopPremium | number | optional | The top margin of the PDF in inches (e.g., 0.4) | ||
marginRightPremium | number | optional | The right margin of the PDF in inches (e.g., 0.4) | ||
marginBottomPremium | number | optional | The bottom margin of the PDF in inches (e.g., 0.4) | ||
marginLeftPremium | number | optional | The left margin of the PDF in inches (e.g., 0.4) | ||
landscapePremium | boolean | optional | Set to true for landscape orientation | - |
Response
The Website to PDF API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<marginLeft>0.4in</marginLeft>
<marginRight>0.4in</marginRight>
<marginTop>0.4in</marginTop>
<marginBottom>0.4in</marginBottom>
<landscape>false</landscape>
<pdfName>128deceb-c515-444b-8863-82cb3f6ba632.pdf</pdfName>
<expires>1766097122116</expires>
<url>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts</url>
<downloadURL>https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/128deceb-c515-444b-8863-82cb3f6ba632.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766097122&Signature=LI747FKqKj5i5TYX3KIoVy%2FHgXsLOSXfVEUM0Ekqz2SiiYOZWuk3Of7QBDUklSrcbjiHV0AjbzFTKt6oDU83UkN282HbmhxwrolN6v1Zb9twVi1y7gmTpapCiJi%2BpA1r89ioe%2Fe0%2FV7KrIWaqsorzpdJrnMqe2izMWBaZq%2FYkSO2qlwSyhg2R8EsfxYNAANtd%2FuNS0RuIzqTdhNCiTrRirnDAKS3dMCySQJRznHFnyqzNj1OXwVjvdpSMn9XhWCUa%2FDRR8q%2BE9B0yF8eTvIrDSe2OzJT%2FJLc9rxcLfXAny21gtNqrzMJPU4yM9Ge%2BEbepmDnNZf9xpODNsnq5eLF0g%3D%3D</downloadURL>
</data>
</response>
status: ok
error: null
data:
marginLeft: 0.4in
marginRight: 0.4in
marginTop: 0.4in
marginBottom: 0.4in
landscape: false
pdfName: 128deceb-c515-444b-8863-82cb3f6ba632.pdf
expires: 1766097122116
url: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts
downloadURL: >-
https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/128deceb-c515-444b-8863-82cb3f6ba632.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766097122&Signature=LI747FKqKj5i5TYX3KIoVy%2FHgXsLOSXfVEUM0Ekqz2SiiYOZWuk3Of7QBDUklSrcbjiHV0AjbzFTKt6oDU83UkN282HbmhxwrolN6v1Zb9twVi1y7gmTpapCiJi%2BpA1r89ioe%2Fe0%2FV7KrIWaqsorzpdJrnMqe2izMWBaZq%2FYkSO2qlwSyhg2R8EsfxYNAANtd%2FuNS0RuIzqTdhNCiTrRirnDAKS3dMCySQJRznHFnyqzNj1OXwVjvdpSMn9XhWCUa%2FDRR8q%2BE9B0yF8eTvIrDSe2OzJT%2FJLc9rxcLfXAny21gtNqrzMJPU4yM9Ge%2BEbepmDnNZf9xpODNsnq5eLF0g%3D%3D
| key | value |
|---|---|
| marginLeft | 0.4in |
| marginRight | 0.4in |
| marginTop | 0.4in |
| marginBottom | 0.4in |
| landscape | false |
| pdfName | 128deceb-c515-444b-8863-82cb3f6ba632.pdf |
| expires | 1766097122116 |
| url | https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts |
| downloadURL | https://storage.googleapis.com/apiverve-helpers.appspot.com/websitetopdf/128deceb-c515-444b-8863-82cb3f6ba632.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766097122&Signature=LI747FKqKj5i5TYX3KIoVy%2FHgXsLOSXfVEUM0Ekqz2SiiYOZWuk3Of7QBDUklSrcbjiHV0AjbzFTKt6oDU83UkN282HbmhxwrolN6v1Zb9twVi1y7gmTpapCiJi%2BpA1r89ioe%2Fe0%2FV7KrIWaqsorzpdJrnMqe2izMWBaZq%2FYkSO2qlwSyhg2R8EsfxYNAANtd%2FuNS0RuIzqTdhNCiTrRirnDAKS3dMCySQJRznHFnyqzNj1OXwVjvdpSMn9XhWCUa%2FDRR8q%2BE9B0yF8eTvIrDSe2OzJT%2FJLc9rxcLfXAny21gtNqrzMJPU4yM9Ge%2BEbepmDnNZf9xpODNsnq5eLF0g%3D%3D |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
marginLeft | string | Left margin of generated PDF in inches | |
marginRight | string | Right margin of generated PDF in inches | |
marginTop | string | Top margin of generated PDF in inches | |
marginBottom | string | Bottom margin of generated PDF in inches | |
landscape | boolean | PDF orientation mode (true for landscape) | |
pdfName | string | Generated PDF filename with unique identifier | |
expires | number | PDF expiration timestamp in milliseconds | |
url | string | Original source URL that was converted to PDF | |
downloadURL | string | Temporary signed URL for downloading the PDF file |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access Website to PDF through GraphQL to combine it with other API calls in a single request. Query only the website to pdf data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
websitetopdf(
input: {
marginTop: 0.4
marginBottom: 0.4
marginLeft: 0.4
marginRight: 0.4
landscape: false
url: "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts"
}
) {
marginLeft
marginRight
marginTop
marginBottom
landscape
pdfName
expires
url
downloadURL
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Website to PDF API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Website to PDF requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Website to PDF API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Website to PDF
Official Website to PDF packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Website to PDF works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Website to PDF?
How many credits does Website to PDF cost?
Each successful Website to PDF API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful website to pdf lookups.
Can I use Website to PDF in production?
The free plan is for testing and development only. For production use of Website to PDF, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use Website to PDF from a browser?
What happens if I exceed my Website to PDF credit limit?
When you reach your monthly credit limit, Website to PDF API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








