cdpfleet Docs Sign up free

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.

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'

Fields

FieldTypeDefaultWhat it does
urlstringrequiredThe 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).
countrystring"random"Two-letter country for the exit IP and for the page's locale, timezone, geolocation and Accept-Language (see countries); "random" picks one. Unknown codes: 400 invalid_country.
max_waitnumber20Seconds 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.
proxystring or string[]the Community proxyOmit 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). proxy_rules isn't supported yet (400 invalid_option).
formatstring"png""png" or "jpeg".
full_pagebooleanfalsetrue captures the whole scrollable page, up to 20,000 px tall (taller pages are clipped).
widthnumber1280Viewport width, 320–3840.
heightnumber720Viewport height, 240–2160.

Good to know

Billing, errors and countries: Functions.