DataForSEO — On Page / Page Screenshot

Retrieve on Page Page Screenshot with the DataForSEO API. The sample response includes URLs. Use it for search visibility research or technical SEO.

Selected price
$0.0048 / callPublished pricing
Sellers / implementations
1 / 1
Requests · 30d
—Loading...
Success rate · 30d
—Loading...

Run sends a real API request. Charges follow the published API contract.

Request parameters
body* array
body[0]* object | null
page url required field absolute URL of the page to snap note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain "error_message":"Screenshot is empty" in the response array
Optional parameters (10)
language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) note: if you do not specify this parameter, some websites may deny access; in this case, you will obtain "error_message":"Screenshot is empty" in the response array
preset for browser screen parameters optional field if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled.
browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; minimum value, in pixels: 240 maximum value, in pixels: 9999
browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; minimum value: 0.5 maximum value: 3
browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be ignored; minimum value, in pixels: 240 maximum value, in pixels: 9999
custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor)
disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false
take a screenshot of the full page optional field set to false if you want to capture only the part of the page displayed before scrolling default value: true
proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de
switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors
‌‌ Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it.

Sample response

{
  "cost": 0.004,
  "status_code": 20000,
  "status_message": "Ok.",
  "tasks": [
    {
      "cost": 0.004,
      "data": {
        "api": "on_page",
        "function": "page_screenshot",
        "url": "https://dataforseo.com/apis"
      },
      "id": "05061850-1535-0444-0000-698f746278b6",
      "path": [
        "v3",
        "on_page",
        "page_screenshot"
      ],
      "result": [
        {
          "crawl_progress": "finished",
          "error_message": null,
          "items": [
            {
              "image": "https://api.dataforseo.com/cdn/screenshot/05061850-1535-0444-0000-698f746278b6"
            }
          ],
          "items_count": 1
        }
      ],
      "result_count": 1,
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "6.3053 sec."
    }
  ],
  "tasks_count": 1,
  "tasks_error": 0,
  "time": "6.3639 sec.",
  "version": "0.1.20220428"
}

Response result

Response structure

Inferred from examples
  • costnumber
  • status_codeinteger
  • status_messagestring
  • tasksobject[]
    • costnumber
    • dataobject
      • apistring
      • functionstring
      • urlstring
    • idstring
    • pathstring[]
    • resultobject[]
      • crawl_progressstring
      • error_messagenull
      • itemsobject[]
        • imagestring
      • items_countinteger
    • result_countinteger
    • status_codeinteger
    • status_messagestring
    • timestring
  • tasks_countinteger
  • tasks_errorinteger
  • timestring
  • versionstring

Common questions

Do I need a separate key for every provider?

Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.

Are these providers interchangeable?

No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.

How is this API billed?

API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.

Where do the price and contract come from?

The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.

How do OpenAny Balance and x402 differ?

OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.

Does Playground send a paid request?

Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.

Use DataForSEO — On Page / Page Screenshot with your agent

Inspect endpoint contracts and confirm availability and pricing before a paid call.