DataForSEO Website Screenshot
https://api.sandbase.ai/v1/api/dataforseo/v3/on_page/page_screenshotCapture a full-page or viewport screenshot of any URL in desktop, mobile or tablet view. Options for custom screen size, language, user agent and dismissing cookie pop-ups.
- Price
- Free
- Method
- POST
- Response
- JSON
- Parameters
- 1 required · 10 optional
Try the model
Playground
[
{
"cost": 0.0048,
"status_code": 20000,
"status_message": "Ok.",
"tasks": [
{
"cost": 0.0048,
"data": {
"accept_language": "en",
"api": "on_page",
"browser_preset": "desktop",
"disable_cookie_popup": true,
"full_page_screenshot": false,
"function": "page_screenshot",
"url": "https://github.com/google/agents-cli/blob/main/skills/google-agents-cli-workflow/SKILL.md"
},
"id": "08200442-2190-0444-0000-d4b83fc6e516",
"path": [
"v3",
"on_page",
"page_screenshot"
],
"result": [
{
"crawl_progress": "finished",
"error_message": null,
"items": [
{
"image": "https://api.dataforseo.com/cdn/screenshot/08200442-2190-0444-0000-d4b83fc6e516"
}
],
"items_count": 1
}
],
"result_count": 1,
"status_code": 20000,
"status_message": "Ok.",
"time": "8.4504 sec."
}
],
"tasks_count": 1,
"tasks_error": 0,
"time": "8.4868 sec.",
"version": "0.1.20260806"
}
]Examples
Select an example to load its inputs and result into the playground.
Model card
Specifications
Pricing
- Base price
- Free
Request & response
- Method
- POST
- Request body
- application/json
- Response
- application/json
- Execution
- sync
Parameters
- url
- string · required
- switch_pool
- boolean · optional
- browser_preset
- string · optional
- accept_language
- string · optional
- ip_pool_for_scan
- string · optional
- custom_user_agent
- string · optional
- browser_screen_width
- integer · optional
- disable_cookie_popup
- boolean · optional
- full_page_screenshot
- boolean · optional
- browser_screen_height
- integer · optional
- browser_screen_scale_factor
- number · optional
Access
- Provider
- DataForSEO
- API
- Platform API
- Base URL
- https://api.sandbase.ai
- Endpoint
- /v1/api/dataforseo/v3/on_page/page_screenshot
- Authentication
- Bearer API key
API README
Website Screenshot API
Pass a URL and get back a hosted screenshot image of the rendered page. Choose a device preset or exact screen size, and capture the full page or only the visible viewport.
Use cases
- Generate thumbnails and previews of web pages.
- Visually monitor competitor landing pages or SERP features.
- Archive how a page looked at a point in time.
Request
curl -X POST "https://api.sandbase.ai/v1/api/dataforseo/v3/on_page/page_screenshot" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://dataforseo.com/apis"}'
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | page url required field absolute URL of the page to capture a screenshot of example: https://dataforseo.com/apis |
switch_pool | boolean | No | switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data |
browser_preset | string | No | preset for browser screen parameters optional field possible values: desktop, mobile, tablet desktop: 1920x1080, scale … |
accept_language | string | No | language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Not… |
ip_pool_for_scan | string | No | proxy pool location optional field possible values: us, de |
custom_user_agent | string | No | custom user agent optional field custom user agent for crawling a website default value: Mozilla/5.0 (compatible; RSite… |
browser_screen_width | integer | No | browser screen width in pixels optional field minimum value: 240 maximum value: 9999 if set, browser_preset is ignored |
disable_cookie_popup | boolean | No | disable the cookie popup optional field set to true to dismiss cookie consent dialogs default value: false |
full_page_screenshot | boolean | No | take a screenshot of the full page optional field set to false to capture only the visible viewport default value: true |
browser_screen_height | integer | No | browser screen height in pixels optional field minimum value: 240 maximum value: 9999 if set, browser_preset is ignored |
browser_screen_scale_factor | number | No | browser screen scale factor optional field minimum value: 0.5 maximum value: 3 if set, browser_preset is ignored |
Example response
Real response for the request above, trimmed to the main fields. User names and long IDs are masked.
{
"status_code": 20000,
"tasks": [
{
"status_message": "Ok.",
"data": {
"api": "on_page",
"function": "page_screenshot",
"url": "https://dataforseo.com/apis"
},
"result": [
{
"crawl_progress": "finished",
"items_count": 1,
"items": [
{
"image": "https://api.dataforseo.com/cdn/screenshot/10060902-2190-0444-0000-91f534c360ca"
}
]
}
]
}
]
}
Notes
browser_preset:desktop(1920×1080),mobile(390×844) ortablet.- Set
disable_cookie_popuptotrueto hide consent banners.
Related APIs
- DataForSEO Google Ads Keyword Search Volume: Get Google Ads search volume, CPC, competition and 12-month trend for up to 1,000 keywords per request, by location and language.
- DataForSEO Google Trends: Get Google Trends interest over time for up to 5 keywords by location, language and time range, with weekly values on a 0–100 scale.
- DataForSEO Google SERP (Advanced): Get live Google organic search results for any keyword, location and language, including AI Overviews, featured snippets, People Also Ask and other SERP featur…
Start building
Send your first request
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/dataforseo/v3/on_page/page_screenshot" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"url": "https://static.sandbase.ai/examples/46031d8f-5e94-4e1f-be8d-c5fa08a87c0d/input/5de63a4b-cc40-4bad-b86c-d9afc7795d54.md",
"accept_language": "en",
"browser_preset": "desktop",
"disable_cookie_popup": true,
"full_page_screenshot": false
}
SANDBASE_JSON
)
printf '%s\n' "$result"Explore more
Related APIs
| API | Price | Response | Released |
|---|---|---|---|
DataForSEO Website ScreenshotThis API DataForSEO | Free | JSON | Jan 1, 2024 |
DataForSEO | Free | JSON | Jan 1, 2024 |
DataForSEO | Free | JSON | Jan 1, 2024 |
DataForSEO | Free | JSON | Jan 1, 2024 |
DataForSEO | Free | JSON | Jan 1, 2024 |
DataForSEO | Free | JSON | Jan 1, 2024 |
Questions
FAQ
How do I use the DataForSEO Website Screenshot API?
Send a POST request to https://api.sandbase.ai/v1/api/dataforseo/v3/on_page/page_screenshot with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.
How much does the DataForSEO Website Screenshot API cost?
DataForSEO Website Screenshot is free to call on SandBase. You only need a SandBase account and API key.
What parameters does the DataForSEO Website Screenshot API accept?
Required: url (string). Optional: switch_pool (boolean), browser_preset (string), accept_language (string), ip_pool_for_scan (string), custom_user_agent (string) and browser_screen_width (integer) and 4 more. The Parameters table and the Playground on this page list every field.
What does the DataForSEO Website Screenshot API return?
A JSON response returned in the same HTTP request (synchronous). The README on this page includes a sample response.
Do I need a DataForSEO developer account or API key?
No. DataForSEO Website Screenshot runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for DataForSEO API access separately.
