Skip to main content
POST
实时 OnPage API 内容解析
立即把任意 url 解析成结构化内容,不需要先爬取——本家族唯一独立可用的工具。browser_preset、browser_screen_width、browser_screen_height、custom_user_agent 控制渲染,disable_cookie_popup 去掉同意弹层,store_raw_html 保留源码。example.com 实测 1.2 KB。响应包在信封里:数据在 tasks[0].result,成败在 tasks[0].status_code——请求被拒时 HTTP 仍是 200。 页面已在某次爬取里时改用 post_dataforseo_on_page_content_parsing,那个免费。

示例

当前未启用。

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
url
string

URL of the content to parse
required field
URL of the page to parse
example:
https://www.fujielectric.com/

custom_user_agent
string | null

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)

browser_preset
string | null

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: to use this parameter, set enable_javascript or enable_browser_rendering to true

browser_screen_width
integer<int64> | null

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;

Note: to use this parameter, set enable_javascript or enable_browser_rendering to true

minimum value, in pixels: 240
maximum value, in pixels: 9999

browser_screen_height
integer | null

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;

Note: to use this parameter, set enable_javascript or enable_browser_rendering to true

minimum value, in pixels: 240
maximum value, in pixels: 9999

browser_screen_scale_factor
number | null

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;

Note: to use this parameter, set enable_javascript or enable_browser_rendering to true

minimum value: 0.5
maximum value: 3

store_raw_html
boolean | null

store HTML of a crawled page
optional field
set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint
default value: false

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

accept_language
string | null

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, pages will be returned with the "type":"broken in the response array

enable_javascript
boolean | null

load javascript on a page
optional field
set to true if you want to load the scripts available on a page
default value: false
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page

enable_browser_rendering
boolean | null

emulate browser rendering to measure Core Web Vitals
optional field
by using this parameter you will be able to emulate a browser when loading a web page;
enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;
default value: false
set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;
if you use this field, enable_javascript, and load_resources parameters must be set to true
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page

enable_xhr
boolean | null

enable XMLHttpRequest on a page
optional field
set to true if you want our crawler to request data from a web server using the XMLHttpRequest object
default value:
false

if you use this field, enable_javascript must be set to true;

switch_pool
boolean | null

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

ip_pool_for_scan
string | null

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

markdown_view
boolean | null

return page content as markdown
optional field
if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;
default value: false

示例:

响应

object | null

Successful operation

version
string | null

API 的当前版本

status_code
integer | null

general status code you can find the full list of the response codes here

status_message
string | null

general informational message you can find the full list of general informational messages here

time
string | null

total execution time, seconds

cost
number<double> | null

任务总成本(美元)

tasks_count
integer<int64> | null

tasks 数组中的任务数量

tasks_error
integer<int64> | null

返回错误的 tasks 数组中的任务数量

tasks
(object | null)[] | null

array of tasks