---
title: "Website Screenshot API"
method: GET
path: "/api/v1/domain/screenshot"
tags: ["Domain"]
---

# Website Screenshot API

`GET /api/v1/domain/screenshot`

## Request

- Base URL: `https://xranks.com`
- URL: `https://xranks.com/api/v1/domain/screenshot`
- Auth: API key in header `Authorization`

Get a screenshot of a website’s homepage without running a browser yourself. The API returns the URL of a WebP image hosted on screenshot.xranks.com that you can show directly in your app.

Use cases: Show website previews in a directory or CRM; Add thumbnails to link lists; Check what a site looks like before you review it.

## Query parameters

- `domain` string, required

## Response `200`

Data for the domain. May instead be an Error object (HTTP 200) when the domain is unknown.

- union
  - ScreenshotResponse
    - `domain` string, required: The domain you asked for.
    - `screenshot` string, uri, required: Link to the homepage screenshot, WebP format.
  - Error
    - `error` string, required: Human-readable message.
    - `code` 'missing_api_key' | 'invalid_api_key' | 'inactive_api_key' | 'quota_exceeded' | 'invalid_domain' | 'domain_not_found' | 'no_data' | 'unknown_service' | 'too_many_domains' | 'invalid_request': Stable machine-readable code.

## Other responses

- `401`: Missing, invalid or inactive API key.
- `429`: Quota used up for the rolling 30 days (or the batch needs more lookups than are left).

---

[API](https://skmtc.dev/xranks/apis/xranks-domain-data-api.md) · [All operations](https://skmtc.dev/xranks/apis/xranks-domain-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xranks/apis/xranks-domain-data-api/revisions/c1c3388c4b34?raw)