Capture Screenshot

JavaScript

import ContextDev from 'context.dev';

const client = new ContextDev({
  apiKey: process.env['CONTEXT_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.web.screenshot();

console.log(response.width);

import os
from context.dev import ContextDev

client = ContextDev(
    api_key=os.environ.get("CONTEXT_DEV_API_KEY"),  # This is the default and can be omitted
)
response = client.web.screenshot()
print(response.width)

package main

import (
	"context"
	"fmt"

	"github.com/context-dot-dev/context-go-sdk"
	"github.com/context-dot-dev/context-go-sdk/option"
)

func main() {
	client := contextdev.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Web.Screenshot(context.TODO(), contextdev.WebScreenshotParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Width)
}

require "context_dev"

context_dev = ContextDev::Client.new(api_key: "My API Key")

response = context_dev.web.screenshot

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use ContextDev\Client;
use ContextDev\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('CONTEXT_DEV_API_KEY') ?: 'My API Key');

try {
  $response = $client->web->screenshot(
    colorScheme: 'light',
    country: 'de',
    directURL: 'https://example.com',
    domain: 'xxx',
    fullScreenshot: 'true',
    handleCookiePopup: 'true',
    maxAgeMs: 0,
    page: 'login',
    scrollOffset: 0,
    tags: ['production', 'team-alpha'],
    timeoutMs: 1,
    viewport: ['height' => 240, 'width' => 240],
    waitForMs: 0,
    zdr: 'enabled',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

context-dev web screenshot \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.context.dev/v1/web/screenshot \
  --header 'Authorization: Bearer <token>'

HttpResponse<String> response = Unirest.get("https://api.context.dev/v1/web/screenshot")
  .header("Authorization", "Bearer <token>")
  .asString();

{
  "status": "<string>",
  "domain": "<string>",
  "screenshot": "<string>",
  "width": 123,
  "height": 123,
  "code": 123,
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

GET

web

screenshot

JavaScript

import ContextDev from 'context.dev';

const client = new ContextDev({
  apiKey: process.env['CONTEXT_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.web.screenshot();

console.log(response.width);

import os
from context.dev import ContextDev

client = ContextDev(
    api_key=os.environ.get("CONTEXT_DEV_API_KEY"),  # This is the default and can be omitted
)
response = client.web.screenshot()
print(response.width)

package main

import (
	"context"
	"fmt"

	"github.com/context-dot-dev/context-go-sdk"
	"github.com/context-dot-dev/context-go-sdk/option"
)

func main() {
	client := contextdev.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Web.Screenshot(context.TODO(), contextdev.WebScreenshotParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Width)
}

require "context_dev"

context_dev = ContextDev::Client.new(api_key: "My API Key")

response = context_dev.web.screenshot

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use ContextDev\Client;
use ContextDev\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('CONTEXT_DEV_API_KEY') ?: 'My API Key');

try {
  $response = $client->web->screenshot(
    colorScheme: 'light',
    country: 'de',
    directURL: 'https://example.com',
    domain: 'xxx',
    fullScreenshot: 'true',
    handleCookiePopup: 'true',
    maxAgeMs: 0,
    page: 'login',
    scrollOffset: 0,
    tags: ['production', 'team-alpha'],
    timeoutMs: 1,
    viewport: ['height' => 240, 'width' => 240],
    waitForMs: 0,
    zdr: 'enabled',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

context-dev web screenshot \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.context.dev/v1/web/screenshot \
  --header 'Authorization: Bearer <token>'

HttpResponse<String> response = Unirest.get("https://api.context.dev/v1/web/screenshot")
  .header("Authorization", "Bearer <token>")
  .asString();

{
  "status": "<string>",
  "domain": "<string>",
  "screenshot": "<string>",
  "width": 123,
  "height": 123,
  "code": 123,
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "INTERNAL_ERROR",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

5 Credits

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

domain

string

Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.

Minimum string length: 3

directUrl

string<uri>

A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https://example.com/pricing'). When provided, the screenshot is taken of this exact URL. You must provide either 'domain' or 'directUrl', but not both.

fullScreenshot

enum<string>

Optional parameter to determine screenshot type. If 'true', takes a full page screenshot capturing all content. If 'false' or not provided, takes a viewport screenshot (standard browser view).

Available options:

true,

false

page

enum<string>

Optional parameter to specify which page type to screenshot. If provided, the system will scrape the domain's links and use heuristics to find the most appropriate URL for the specified page type (30 supported languages). If not provided, screenshots the main domain landing page. Only applicable when using 'domain', not 'directUrl'.

Available options:

login,

signup,

blog,

careers,

pricing,

terms,

privacy,

contact

waitForMs

integer | null

default:3000

Optional browser wait time in milliseconds after initial page load before taking the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when omitted.

Required range: 0 <= x <= 30000

viewport

object

Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.

Show child attributes

handleCookiePopup

default:false

Optional parameter to control cookie/consent popup handling. If 'true', we dismiss cookie banner before capture. If 'false' or not provided, captures the page without that step.

colorScheme

enum<string>

Optional parameter to choose the site's visual theme in the screenshot. Use 'light' or 'dark' when the site offers both appearances.

Available options:

light,

dark

scrollOffset

integer | null

Optional vertical scroll offset in pixels for capturing a long page in viewport-sized chunks. When provided, the full page is captured once and the returned image is the viewport-sized slice that begins at this Y offset (e.g. request scrollOffset=0, then 1080, then 2160 to walk a 1920x1080 landing page top to bottom). The final slice may be shorter than the viewport height. Takes precedence over fullScreenshot. Max: 100000.

Required range: 0 <= x <= 100000

maxAgeMs

integer | null

default:86400000

Return a cached screenshot if a prior screenshot for the same parameters exists and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh.

Required range: 0 <= x <= 2592000000

country

enum<string>

Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev residential proxy exit location. Must be one of Context.dev's supported countries. When provided, Context.dev fetches the target page from that country.

Available options:

ad,

ae,

af,

ag,

ai,

al,

am,

ao,

ar,

at,

au,

aw,

az,

ba,

bb,

bd,

be,

bf,

bg,

bh,

bi,

bj,

bm,

bn,

bo,

bq,

br,

bs,

bw,

by,

bz,

ca,

cd,

cf,

cg,

ch,

ci,

cl,

cm,

cn,

co,

cr,

cv,

cw,

cy,

cz,

de,

dj,

dk,

dm,

do,

dz,

ec,

ee,

eg,

es,

et,

fi,

fj,

fr,

ga,

gb,

gd,

ge,

gf,

gg,

gh,

gm,

gn,

gp,

gq,

gr,

gt,

gu,

gw,

gy,

hk,

hn,

hr,

ht,

hu,

id,

ie,

il,

im,

in,

iq,

ir,

is,

it,

je,

jm,

jo,

jp,

ke,

kg,

kh,

kn,

kr,

kw,

ky,

kz,

la,

lb,

lc,

lk,

lr,

ls,

lt,

lu,

lv,

ly,

ma,

mc,

md,

me,

mf,

mg,

mk,

ml,

mm,

mn,

mo,

mq,

mr,

mt,

mu,

mv,

mw,

mx,

my,

mz,

na,

nc,

ne,

ng,

ni,

nl,

no,

np,

nz,

om,

pa,

pe,

pf,

pg,

ph,

pk,

pl,

pr,

ps,

pt,

py,

qa,

re,

ro,

rs,

ru,

rw,

sa,

sc,

sd,

se,

sg,

si,

sk,

sl,

sm,

sn,

so,

sr,

ss,

st,

sv,

sx,

sy,

sz,

tc,

td,

tg,

th,

tj,

tl,

tm,

tn,

tr,

tt,

tw,

tz,

ua,

ug,

us,

uy,

uz,

vc,

ve,

vg,

vi,

vn,

ye,

yt,

za,

zm,

zw

Example:

"de"

timeoutMS

integer

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Required range: 1 <= x <= 300000

zdr

enum<string>

default:disabled

Set to enabled to bypass shared caches and omit request and response content from retained usage logs. Requires zero data retention to be enabled for your organization (contact [email protected]), otherwise the request fails with ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.

Available options:

enabled,

disabled

Response

Successful response

status

string

Status of the response, e.g., 'ok'

domain

string

The normalized domain that was processed

screenshot

string

Public image URL for standard requests, or an in-memory data URL when ZDR is enabled.

screenshotType

enum<string>

Type of screenshot that was captured

Available options:

viewport,

fullPage

width

integer

Width in pixels of the returned screenshot image

height

integer

Height in pixels of the returned screenshot image

code

integer

HTTP status code

key_metadata

object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Show child attributes

Scrape Images

Crawl Sitemap

⌘I

Web Extraction

Brand Intelligence

Entity Enrichment

Monitor Infrastructure

Utility

Authorizations

Query Parameters

Response