[Functions](https://cdpfleet.com/docs/functions)

# Screenshot

A PNG or JPEG of the page as a real browser renders it, the viewport or the full page. `POST https://cdpfleet.com/v1/functions/screenshot` → `image/png` or `image/jpeg`.

 

```bash
curl -s https://cdpfleet.com/v1/functions/screenshot \
  -H "x-api-key: $CDPFLEET_API_KEY" -H "content-type: application/json" \
  -d '{"url":"https://example.com/","country":"de","full_page":true}' -o shot.png -D - | grep -i '^x-call-id'
```

```js
// Node.js 18+: save as screenshot.mjs, run node screenshot.mjs
import { writeFile } from 'node:fs/promises';

const res = await fetch('https://cdpfleet.com/v1/functions/screenshot', {
  method: 'POST',
  headers: { 'x-api-key': process.env.CDPFLEET_API_KEY, 'content-type': 'application/json' },
  body: JSON.stringify({
    url: 'https://example.com/',
    country: 'de',
    full_page: true,
  }),
  signal: AbortSignal.timeout(30000),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`); // 429: wait Retry-After seconds
const bytes = Buffer.from(await res.arrayBuffer());
await writeFile('shot.png', bytes);
console.log(`shot.png: ${bytes.length} bytes`);
```

```python
# Python 3 with requests (pip install requests): save as screenshot.py, run python screenshot.py
import os
import requests

r = requests.post(
    "https://cdpfleet.com/v1/functions/screenshot",
    headers={"x-api-key": os.environ["CDPFLEET_API_KEY"]},
    json={
        "url": "https://example.com/",
        "country": "de",
        "full_page": True,
    },
    timeout=30,
)
if not r.ok:
    raise SystemExit(f"{r.status_code} {r.text}")  # 429: wait r.headers["Retry-After"] seconds
open("shot.png", "wb").write(r.content)
print(f"shot.png: {len(r.content)} bytes")
```

```java
// Java 17+: save as Main.java, run java Main.java
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.time.Duration;

public class Main {
  public static void main(String[] args) throws Exception {
    String body = """
        {
          "url": "https://example.com/",
          "country": "de",
          "full_page": true
        }
        """;
    HttpResponse<byte[]> res = HttpClient.newHttpClient().send(
        HttpRequest.newBuilder(URI.create("https://cdpfleet.com/v1/functions/screenshot"))
            .header("x-api-key", System.getenv("CDPFLEET_API_KEY"))
            .header("content-type", "application/json")
            .timeout(Duration.ofSeconds(30))
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build(),
        HttpResponse.BodyHandlers.ofByteArray());
    if (res.statusCode() != 200) { // 429: wait Retry-After seconds
      throw new RuntimeException(res.statusCode() + " " + new String(res.body()));
    }
    Files.write(Path.of("shot.png"), res.body());
    System.out.println("shot.png: " + res.body().length + " bytes");
  }
}
```

```csharp
// .NET 8+: dotnet new console, replace Program.cs with this, run dotnet run
using System.Text;

using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("CDPFLEET_API_KEY"));
var body = """
    {
      "url": "https://example.com/",
      "country": "de",
      "full_page": true
    }
    """;
var res = await http.PostAsync("https://cdpfleet.com/v1/functions/screenshot",
    new StringContent(body, Encoding.UTF8, "application/json"));
if (!res.IsSuccessStatusCode) // 429: wait Retry-After seconds
    throw new Exception($"{(int)res.StatusCode} {await res.Content.ReadAsStringAsync()}");
var bytes = await res.Content.ReadAsByteArrayAsync();
await File.WriteAllBytesAsync("shot.png", bytes);
Console.WriteLine($"shot.png: {bytes.Length} bytes");
```

```go
// Go 1.21+: save as main.go, run go run main.go
package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
	"os"
	"strings"
	"time"
)

func main() {
	body := `{
	  "url": "https://example.com/",
	  "country": "de",
	  "full_page": true
	}`
	req, _ := http.NewRequest("POST", "https://cdpfleet.com/v1/functions/screenshot", strings.NewReader(body))
	req.Header.Set("x-api-key", os.Getenv("CDPFLEET_API_KEY"))
	req.Header.Set("content-type", "application/json")
	res, err := (&http.Client{Timeout: 30 * time.Second}).Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	data, err := io.ReadAll(res.Body)
	if err != nil {
		log.Fatal(err)
	}
	if res.StatusCode != http.StatusOK { // 429: wait Retry-After seconds
		log.Fatalf("%s %s", res.Status, data)
	}
	if err := os.WriteFile("shot.png", data, 0o644); err != nil {
		log.Fatal(err)
	}
	fmt.Printf("shot.png: %d bytes\n", len(data))
}
```

## Fields

| Field | Type | Default | What it does |
| --- | --- | --- | --- |
| `url` | string | required | The page to load. A public `http` or `https` address: private, loopback, link-local, CGNAT and cloud-metadata addresses, `localhost`, `.local`/`.internal` names and names that resolve to them are refused (`400 invalid_url`). |
| `country` | string | `"random"` | Two-letter country for the exit IP and for the page's locale, timezone, geolocation and `Accept-Language` (see [countries](#countries)); `"random"` picks one. Unknown codes: `400 invalid_country`. |
| `max_wait` | number | `20` | Seconds to wait for the page to load, 1–60 (`400 invalid_option` otherwise). The whole call returns within about `max_wait` + 5 s, so a client timeout of `max_wait` + 10 s is safe. A page that is still loading then comes back partial (below); one that never started: `408 page_timeout`. |
| `proxy` | string or string\[\] | the Community proxy | Omit it to use the free Community proxy in `country`. Or: your own proxy URL (`http://`, `https://`, `socks5://`), a list (one is picked per call), a `cdpfleet-plan…` token, or a residential `cdpfleet-resi…` token (tier, country, device OS, sticky session) billed per GB to your residential balance ([proxies](https://cdpfleet.com/docs/proxies)). `proxy_rules` isn't supported yet (`400 invalid_option`). |
| `format` | string | `"png"` | `"png"` or `"jpeg"`. |
| `full_page` | boolean | `false` | `true` captures the whole scrollable page, up to 20,000 px tall (taller pages are clipped). |
| `width` | number | `1280` | Viewport width, 320–3840. |
| `height` | number | `720` | Viewport height, 240–2160. |

## Good to know

-   The page loads, then waits for the network to go quiet (up to 10 s, within `max_wait`) so late images and fonts are in the picture.

Billing, errors and countries: [Functions](https://cdpfleet.com/docs/functions).

---
Source: https://cdpfleet.com/docs/functions/screenshot · Markdown: https://cdpfleet.com/docs/functions/screenshot.md · All docs for AI tools: https://cdpfleet.com/llms.txt