# Скриншот страницы OnPage API

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/page_screenshot`

**Tags:** DataForSEO

Рендерит любой `url` и возвращает скриншот; `full_page_screenshot` включает всю высоту прокрутки, а `browser_screen_width` и `browser_screen_height` задают область просмотра. Работает автономно — обход не нужен. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. ⚠️ Изображение — большой результат инструмента ещё до того, как агент сможет с ним что-то сделать; запрашивайте скриншот, только когда важен именно визуал, а если нужен текст, используйте `post_dataforseo_on_page_content_parsing_live`.

### Справочные цены

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.0051.
- Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Справочные метаданные, а не коммерческое предложение для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "<em>URL страницы</em><br><strong>обязательное поле</strong><br>абсолютный URL страницы для снимка<br><strong>примечание:</strong> если указанный здесь URL возвращает код состояния 404 или указанное значение не является допустимым URL, в массиве ответа вы получите <code>\"error_message\":\"Screenshot is empty\"</code>"
          },
          "accept_language": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>языковой заголовок для доступа к веб-сайту</em><br>необязательное поле<br>поддерживаются все форматы локалей (xx, xx-XX, xxx-XX и т. д.)<br><strong>примечание:</strong> если не указать этот параметр, некоторые веб-сайты могут отказать в доступе; в этом случае в массиве ответа вы получите <code>\"error_message\":\"Screenshot is empty\"</code>"
          },
          "custom_user_agent": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский user agent</em><br>необязательное поле<br>пользовательский user agent для обхода веб-сайта<br>пример: <code>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<br></code><br>значение по умолчанию: <code>Mozilla/5.0 (compatible; RSiteAuditor)</code>"
          },
          "browser_preset": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пресет параметров экрана браузера</em><br>необязательное поле<br>если вы используете это поле, указывать <code>browser_screen_width</code>, <code>browser_screen_height</code>, <code>browser_screen_scale_factor</code> не нужно<p>возможные значения:<br><code>desktop</code>, <code>mobile</code>, <code>tablet</code><p>пресет <code>desktop</code> применяет следующие значения:<p><code>browser_screen_width: 1920</code><br><code>browser_screen_height: 1080</code><br><code>browser_screen_scale_factor: 1</code><p>пресет <code>mobile</code> применяет следующие значения:<p><code>browser_screen_width: 390</code><br><code>browser_screen_height: 844</code><br><code>browser_screen_scale_factor: 3</code><p>пресет <code>tablet</code> применяет следующие значения:<p><code>browser_screen_width: 1024</code><br><code>browser_screen_height: 1366</code><br><code>browser_screen_scale_factor: 2</code><p><strong>Примечание:</strong> в этом эндпоинте параметры <code>enable_browser_rendering</code>, <code>enable_javascript</code>, <code>load_resources</code> и <code>enable_xhr</code> всегда включены."
          },
          "browser_screen_width": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>ширина экрана браузера</em><br>необязательное поле<br>можно задать собственную ширину экрана браузера для аудита конкретного устройства;<br>если вы используете это поле, указывать <code>browser_preset</code> не нужно, так как он будет проигнорирован;<p>минимальное значение в пикселях: <code>240</code> <br>максимальное значение в пикселях: <code>9999</code>",
            "format": "int64"
          },
          "browser_screen_height": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>высота экрана браузера</em><br>необязательное поле<br>можно задать собственную высоту экрана браузера для аудита конкретного устройства;<br>если вы используете это поле, указывать <code>browser_preset</code> не нужно, так как он будет проигнорирован;<p>минимальное значение в пикселях: <code>240</code> <br>максимальное значение в пикселях: <code>9999</code>"
          },
          "browser_screen_scale_factor": {
            "type": [
              "number",
              "null"
            ],
            "description": "<em>масштаб экрана браузера</em><br>необязательное поле<br>можно задать собственное соотношение разрешения экрана браузера для аудита конкретного устройства;<br>если вы используете это поле, указывать <code>browser_preset</code> не нужно, так как он будет проигнорирован;<p>минимальное значение: <code>0.5</code> <br>максимальное значение: <code>3</code>"
          },
          "full_page_screenshot": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>сделать снимок всей страницы</em><br>необязательное поле<br>задайте <code>false</code>, если хотите захватить только часть страницы, отображаемую до прокрутки<br>значение по умолчанию: <code>true</code>"
          },
          "disable_cookie_popup": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>отключить всплывающее окно cookie </em><br>необязательное поле<br>задайте <code>true</code>, если хотите отключить всплывающее окно с запросом согласия на использование cookie;<br>значение по умолчанию: <br><code>false</code>"
          },
          "switch_pool": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>переключение пула прокси</em><br>необязательное поле<br>если <code>true</code>, для получения запрошенных данных будут использоваться дополнительные пулы прокси;<br>параметр можно использовать, если одновременно задано множество задач, что приводит к периодическим ошибкам <code>rate-limit</code> и/или <code>site_unreachable</code>"
          },
          "ip_pool_for_scan": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пул прокси</em><br>необязательное поле<br>можно выбрать расположение пула прокси, который будет использоваться для получения запрошенных данных;<br>параметр можно использовать, если содержимое страницы недоступно в одном из расположений, что приводит к периодическим ошибкам <code>site_unreachable</code><br>возможные значения: <code>us</code>, <code>de</code>"
          }
        },
        "example": [
          {
            "url": "https://dataforseo.com/apis"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "url": "https://dataforseo.com/apis"
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_OnPagePageScreenshotResponseInfo"
    }
  ]
}
```

### 400 — Запрос не удалось обработать. Проверьте параметры запроса.

### 401 — Требуется действительный API-ключ Felo.

### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.

### 403 — Аккаунту не разрешено выполнять эту операцию.

### 429 — Достигнут лимит запросов или расходов.

### 502 — Сервис не смог выполнить запрос.

### 503 — API или сервис биллинга временно недоступны.

### 504 — Истекло время ожидания обработки запроса.

### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "текущая версия API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "общий код состояния.\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее информационное сообщение.\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks, возвращённых с ошибкой",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "идентификатор задачи\nуникальный идентификатор задачи в нашей системе в формате UUID"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 10000-60000\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "информационное сообщение задачи\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число элементов в массиве result",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "путь URL"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "содержит те же параметры, что вы указали в POST-запросе"
    }
  }
}
```

### Response36Afe1097B20_OnPagePageScreenshotResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPagePageScreenshotResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPagePageScreenshotTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPagePageScreenshotResultInfo

`#/components/schemas/Response36Afe1097B20_OnPagePageScreenshotResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>статус сеанса сканирования</em><br>возможные значения: <code>in_progress</code>, <code>finished</code>"
    },
    "error_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>сообщение об ошибке</em><br>если указанный <code>url</code> возвращает код состояния 404 или не является допустимым URL, вы получите <code>\"error_message\":\"Screenshot is empty\"</code><br>если ошибки нет, значение будет <code>null</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество элементов в массиве результатов</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_ScreenshotItem"
          }
        ]
      },
      "description": "<em>массив элементов</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPagePageScreenshotTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPagePageScreenshotTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPagePageScreenshotResultInfo"
              }
            ]
          },
          "description": "<em>массив результатов</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_ScreenshotItem

`#/components/schemas/Response36Afe1097B20_ScreenshotItem`

```json
{
  "type": "object",
  "properties": {
    "image": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>скриншот запрошенной страницы</em><br>URL скриншота страницы в хранилище DataForSEO<br><strong>примечание: скриншот страницы, сохранённый в хранилище DataForSEO, доступен только в течение одного дня после выполнения запроса</strong>"
    }
  }
}
```