> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/web/screenshot/get](https://www.socialfetch.dev/docs/api/v1/web/screenshot/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/web/screenshot/get.mdx](https://www.socialfetch.dev/docs/api/v1/web/screenshot/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 164 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Capture website screenshot (https://www.socialfetch.dev/docs/api/v1/web/screenshot/get)

## Summary

Capture a screenshot of a public web page URL as a hosted image artifact.

**Tags:** `Web`

## HTTP

- **Method:** GET
- **Path:** `/v1/web/screenshot`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.web.getScreenshot({ url: "https://www.socialfetch.dev/" })`
- **Accepted identifiers:** `url` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `restricted`

## Agent notes

- **Empty results:** `lookupStatus: restricted` means bot/access protection blocked the capture; an artifact may still be present.

## Credits

- 1 credit (2 with region)

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `url` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 2083
- **Description:** Web page URL to fetch.

### `fullPage` (query)

- **Required:** no
- **Constraints:** type `boolean`; default: `false`
- **Description:** When true, capture the full scrollable page. Default: false (viewport).

### `viewportWidth` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `1280`; minimum: 320; maximum: 3840
- **Description:** Viewport width in CSS pixels. Default: 1280.

### `viewportHeight` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `800`; minimum: 320; maximum: 3840
- **Description:** Viewport height in CSS pixels. Default: 800.

### `deviceScaleFactor` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `1`; minimum: 1; maximum: 3
- **Description:** Device scale factor (1–3). Default: 1.

### `selector` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 500
- **Description:** CSS selector to clip the screenshot to a single element. Cannot be combined with fullPage.

### `format` (query)

- **Required:** no
- **Constraints:** type `string`; enum: png, jpeg, webp; default: `png`
- **Description:** Output image format. Default: png.

### `quality` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 100
- **Description:** JPEG/WebP quality 1–100. Invalid when format is png.

### `delay` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `0`; minimum: 0; maximum: 10000
- **Description:** Extra settle delay in milliseconds after load (0–10000).

### `waitFor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 500
- **Description:** CSS selector to wait for before capturing.

### `waitUntil` (query)

- **Required:** no
- **Constraints:** type `string`; enum: load, domcontentloaded, networkidle; default: `load`
- **Description:** Navigation wait condition. `networkidle` is bounded and resolves on idle or a short cap, whichever comes first. Default: load.

### `blockCookieBanners` (query)

- **Required:** no
- **Constraints:** type `boolean`; default: `true`
- **Description:** Dismiss/block cookie consent banners. Default: true.

### `blockAds` (query)

- **Required:** no
- **Constraints:** type `boolean`; default: `true`
- **Description:** Block ads and trackers during render. Default: true.

### `darkMode` (query)

- **Required:** no
- **Constraints:** type `boolean`; default: `false`
- **Description:** Request prefers-color-scheme: dark. Default: false.

### `region` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Optional ISO 3166-1 alpha-2 country for geo-located rendering (+1 credit).

### `cacheMode` (query)

- **Required:** no
- **Constraints:** type `string`; enum: enabled, bypass, write_only; default: `enabled`
- **Description:** Cache behavior. `enabled`: read from cache if present, else fetch and write to cache. `bypass`: always fetch fresh, ignoring and not updating the cache. `write_only`: always fetch fresh, but write the result to cache without reading from it first. Default: `enabled`.

### `cacheTtl` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 60; maximum: 604800
- **Description:** Optional Redis artifact-cache TTL in seconds (60–604800). Must stay strictly below the 7-day object lifetime.

### `response` (query)

- **Required:** no
- **Constraints:** type `string`; enum: url, base64; default: `url`
- **Description:** Delivery mode. `url` (default) returns a hosted CDN URL valid for 7 days. `base64` returns the image bytes inline when small enough.

## Behavior notes

- **`region`**: Optional ISO 3166-1 alpha-2 country for geo-located rendering (+1 credit).

## Responses (status codes)

- **200**: Screenshot capture result.
- **400**: Invalid query parameters or disallowed URL
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Screenshot could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Screenshot capture result.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, restricted. Whether page content could be extracted. Restricted means bot protection or similar access controls blocked automated fetching.
  - **url** (required) — type `string`. URL that was rendered.
  - **finalUrl** (optional) — type `string`. Final URL after redirects, when available.
  - **status** (required) — type `integer`; nullable. HTTP status of the main document when available; null when restricted.
  - **title** (optional) — type `string`; nullable. Document title when available.
  - **artifact** (required) — type `object`; nullable. Hosted screenshot artifact when capture succeeded (found or restricted). Null only when no image was produced.
    - **url** (required) — type `string`. Public HTTPS URL of the artifact on the media CDN. Valid until expiresAt.
    - **format** (required) — type `string`; enum: png, jpeg, webp. Encoded image format of the artifact.
    - **mime** (required) — type `string`; minLength: 1. MIME type of the artifact, e.g. image/png.
    - **bytes** (required) — type `integer`; minimum: 0. Artifact size in bytes.
    - **width** (required) — type `integer`; minimum: 0; nullable. Pixel width when known; null for non-raster artifacts.
    - **height** (required) — type `integer`; minimum: 0; nullable. Pixel height when known; null for non-raster artifacts.
    - **expiresAt** (required) — type `string`. ISO 8601 timestamp when the hosted URL expires and the object is deleted.
  - **base64** (optional) — type `string`. Base64-encoded image bytes when response=base64 and the payload is within size limits.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "url": "https://www.socialfetch.dev/",
    "finalUrl": "https://www.socialfetch.dev/",
    "status": 200,
    "title": "Social Fetch — Social media scraper API",
    "artifact": {
      "url": "https://cdn-socialfetch.dev/prod/screenshots/7d/2026/08/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.png",
      "format": "png",
      "mime": "image/png",
      "bytes": 84210,
      "width": 1280,
      "height": 800,
      "expiresAt": "2026-08-10T12:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_01example_screenshot",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid query parameters or disallowed URL **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Screenshot could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.web.getScreenshot({
  url: "https://www.socialfetch.dev",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/web/screenshot?url=https://www.socialfetch.dev",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/web/screenshot?url=https://www.socialfetch.dev" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/web/screenshot?url=https://www.socialfetch.dev",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: optional query parameters

First request illustrating common optional query flags (adjust values to your integration):

```javascript
const url = "https://api.socialfetch.dev/v1/web/screenshot?region=US";
const response = await fetch(url, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const data = await response.json();
```