DataForSEO OnPage API
The OnPage API from DataForSEO — 30 operation(s) for onpage.
DataForSEO OnPage API is one of 12 APIs that DataForSEO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include OnPage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 1 JSON Schema.
This API exposes 30 operations across 30 paths, and defines 156 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.
Requests are made against 2 base URLs: https://api.dataforseo.com, https://sandbox.dataforseo.com.
30 operations
30 paths
156 schemas
8 GET22 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
DataForSEO OnPage API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
Paths & Operations 30
Across 30 paths, the API surfaces 30 operations — 8 GET, 22 POST. Each is listed below with its method, path, parameters, and response codes.
OnPage 30
POST
/v3/on_page/id_list
This endpoint is designed to provide you with a list of IDs and metadata for all On-Page tasks created within the specified time period, including both successful and uncompleted tasks. for more info…
POST
/v3/on_page/errors
By calling this endpoint you will receive information about the OnPage API tasks that returned an error within the past 7 days. for more info please visit 'https://docs.dataforseo.com/v3/onpage/error…
POST
/v3/on_page/force_stop
This endpoint is designed to force stop the crawl process of websites you specified in a task. The execution of all the tasks associated with the IDs indicated in your request to this endpoint will b…
GET
/v3/on_page/available_filters
OnPage API supports plenty of customizable crawling parameters that allow you to adapt the extraction of website data to your requirements and modify the thresholds for various performance indicators…
POST
/v3/on_page/task_post
OnPage API checks websites for 60+ customizable on-page parameters defines and displays all found flaws and opportunities for optimization so that you can easily fix them. It checks meta tags, duplic…
GET
/v3/on_page/tasks_ready
The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet. for more info please visit 'https://docs.dataforseo.com/v3/onpage-tasks…
GET
/v3/on_page/summary/{id}
Using this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. As a result, you will know what functions to…
POST
/v3/on_page/pages
This endpoint returns a list of crawled pages with on-page check-ups and other metrics related to the page performance. Using this function you will get page-specific data with detailed information o…
POST
/v3/on_page/pages_by_resource
This endpoint will return the list of pages where a specific resource is located. Using this function you will also get the data related to the pages that contain a specified resource. You can get th…
POST
/v3/on_page/resources
This endpoint will provide you with a list of resources, including images, scripts, stylesheets, and broken elements. You will get a detailed overview of every resource found on the crawled pages. fo…
POST
/v3/on_page/duplicate_tags
This endpoint returns a list of pages that contain duplicate title or description tags. The response also contains data related to page performance. for more info please visit 'https://docs.dataforse…
POST
/v3/on_page/duplicate_content
This endpoint returns a list of pages that have content similar to the page specified in the request. The response also contains data related to page performance and the similarity index that indicat…
POST
/v3/on_page/links
This endpoint will provide you with a list of internal and external links detected on a target website. The following link types are supported: anchor – links that point to a specific portion of a we…
POST
/v3/on_page/redirect_chains
Redirect chains occur when there are at least two redirects between the initial URL and the destination URL. For example, if page A redirects to page B which redirects to page C, such a series of red…
POST
/v3/on_page/non_indexable
This endpoint returns a list of pages that are blocked from being indexed by Google and other search engines through robots.txt, HTTP headers, or meta tags settings. for more info please visit 'https…
POST
/v3/on_page/waterfall
This endpoint is designed to provide you with the page speed insights. Using this function you can get detailed information about the page loading time, time to secure connection, the time it takes t…
POST
/v3/on_page/keyword_density
This endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. You can filter and sort the data that will be retrieved with t…
POST
/v3/on_page/microdata
This endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results o…
POST
/v3/on_page/raw_html
This endpoint returns the HTML of a page you indicate in the request. for more info please visit 'https://docs.dataforseo.com/v3/onpage/rawhtml/?bash'
POST
/v3/on_page/page_screenshot
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. for more info please vi…
POST
/v3/on_page/content_parsing
This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. for more info…
POST
/v3/on_page/content_parsing/live
This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. for more info…
POST
/v3/on_page/instant_pages
Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search. for more info please visit 'https://docs.dataforseo.com/v3…
GET
/v3/on_page/lighthouse/languages
You will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks…
GET
/v3/on_page/lighthouse/audits
The OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages. for more info please visit 'https://docs.dataforseo.com/v3/onpage/lighthou…
GET
/v3/on_page/lighthouse/versions
OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages. for more info please visit 'https://docs.dataforseo.com/v3/onpage/lighthouse/v…
POST
/v3/on_page/lighthouse/task_post
The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. for more info please visit 'https://docs.dataforseo.com/v3/onpage/li…
GET
/v3/on_page/lighthouse/tasks_ready
The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postbackurl, you can re…
GET
/v3/on_page/lighthouse/task_get/json/{id}
The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. This endpoint will provide you with the results of Lighthouse Audit.…
POST
/v3/on_page/lighthouse/live/json
The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. for more info please visit 'https://docs.dataforseo.com/v3/onpage/li…
Schemas 156
The contract defines 156 schemas that model the data the API accepts and returns. The most detailed are OnPageTaskPostRequestInfo (43 properties), PageMetaInfo (30 properties), OnPageInstantPagesRequestInfo (20 properties), DomainInfo (15 properties). Each schema is shown below with its type and property counts.
OnPageNonIndexableRequestInfo
object
4 properties
OnPageDuplicateContentItem
object
3 properties
BaseResponseTaskInfo
object
8 properties
OnPageDuplicateTagsRequestInfo
object
6 properties
OnPageDuplicateContentRequestInfo
object
6 properties
OnPageMicrodataResultInfo
object
5 properties
TopicInfo
object
8 properties
OnPageRawHtmlResultInfo
object
4 properties
OnPageLighthouseTasksReadyResultInfo
object
3 properties
OnPageWaterfallResultInfo
object
4 properties
OnPageAvailableFiltersResultInfo
object
8 properties
OnPageNonIndexableResponseInfo
object
SectionContentItemInfo
object
3 properties
OnPageMicrodataResponseInfo
object
OnPagePagesByResourceRequestInfo
object
7 properties
OnPageContentParsingResultInfo
object
4 properties
OnPagePagesResultInfo
object
7 properties
OnPageLinksRequestInfo
object
8 properties
OnPageDuplicateContentTaskInfo
object
OnPageResourcesTaskInfo
object
OnPageNonIndexableTaskInfo
object
OnPageLighthouseTaskPostResponseInfo
object
OnPageTasksReadyResponseInfo
object
OnPageRawHtmlResponseInfo
object
OnPageWaterfallItem
object
12 properties
OnPageDuplicateTagsTaskInfo
object
OnPageTasksReadyResultInfo
object
4 properties
OnPageContentParsingLiveResponseInfo
object
OnPageRawHtmlTaskInfo
object
OnPageKeywordDensityResultInfo
object
5 properties
OnPageKeywordDensityRequestInfo
object
7 properties
OnPageNonIndexableItem
object
2 properties
TableContentItemInfo
object
1 property
PageSectionContentInfo
object
3 properties
OnPagePagesRequestInfo
object
7 properties
OnPageAvailableFiltersTaskInfo
object
OnPageLinksTaskInfo
object
OnPageSummaryResultInfo
object
6 properties
AvailibleVersions
object
2 properties
HunspellInfo
object
2 properties
MicrodataFieldsInfo
object
5 properties
OnPageInstantPagesRequestInfo
object
20 properties
OnPageTaskPostRequestInfo
object
43 properties
OnPageDuplicateContentResultInfo
object
4 properties
OnPageSummaryResponseInfo
object
OnPageInstantPagesTaskInfo
object
OnPageLighthouseVersionsTaskInfo
object
TestSummary
object
4 properties
PageContentInfo
object
8 properties
OnPageContentParsingTaskInfo
object
OnPageContentParsingLiveTaskInfo
object
OnPageLighthouseVersionsResultInfo
object
1 property
OnPageInstantPagesResponseInfo
object
OnPageResourceIssueInfo
object
resource errors and warnings
2 properties
OnPageResourceIssueItemInfo
object
4 properties
OnPageLighthouseLiveJsonRequestInfo
object
8 properties
OnPageResourcesResponseInfo
object
OnPageRedirectChainsTaskInfo
object
OnPageSummaryTaskInfo
object
ScreenshotItem
object
1 property
OnPageLighthouseLanguagesResultInfo
object
2 properties
OnPageDuplicateTagsResponseInfo
object
OnPageLighthouseLanguagesTaskInfo
object
OnPageLighthouseLanguagesResponseInfo
object
OnPageKeywordDensityItem
object
3 properties
OnPageRawHtmlItem
object
1 property
OnPagePageScreenshotResultInfo
object
4 properties
ContentRatingInfo
object
5 properties
OnPagePageScreenshotRequestInfo
object
11 properties
OnPageLighthouseTasksReadyTaskInfo
object
CacheControl
object
2 properties
OnPagePageScreenshotTaskInfo
object
OnPageForceStopResponseInfo
object
HtmlContentInfo
object
11 properties
RowCellInfo
object
3 properties
OnPageErrorsResponseInfo
object
OnPageMicrodataTaskInfo
object
OnPageInstantPagesResultInfo
object
5 properties
DomainInfo
object
15 properties
OnPageLighthouseLiveJsonResponseInfo
object
OnPageErrorsTaskInfo
object
OnPageLighthouseTaskGetJsonResponseInfo
object
OnPageDuplicateTagsItem
object
3 properties
OnPageKeywordDensityTaskInfo
object
OnPageHtmlResourceItem
object
OnPagePagesByResourceTaskInfo
object
OnPageRedirectChainsResultInfo
object
5 properties
OnPageNonIndexableResultInfo
object
5 properties
OnPageLinksResponseInfo
object
OnPageForceStopTaskInfo
object
OnPagePageScreenshotResponseInfo
object
ContentCommentInfo
object
6 properties
OnPageKeywordDensityResponseInfo
object
OnPageContentParsingLiveResultInfo
object
4 properties
PageMetrics
object
12 properties
OnPageRedirectChainsRequestInfo
object
6 properties
OnPageAvailableFiltersResponseInfo
object
OnPageForceStopRequestInfo
object
1 property
WaterfallResourceInfo
object
8 properties
HunspellMisspelledInfo
object
1 property
OnPageDuplicateTagsResultInfo
object
6 properties
ContentOfferInfo
object
4 properties
OnPageTaskPostResponseInfo
object
OnPageWaterfallResponseInfo
object
LastModified
object
3 properties
OnPageLighthouseTasksReadyResponseInfo
object
TableContentInfo
object
3 properties
OnPageTaskPostTaskInfo
object
OnPageIdListTaskInfo
object
OnPageLighthouseLiveJsonTaskInfo
object
OnPageWaterfallTaskInfo
object
OnPageResourcesResultInfo
object
7 properties
CrawlStatusInfo
object
3 properties
OnPageContentParsingResponseInfo
object
OnPageIdListResponseInfo
object
ContentUrlInfo
object
2 properties
BaseOnPageLinkItem
object
14 properties
OnPageMicrodataRequestInfo
object
3 properties
OnPageRedirectLinkItem
object
OnPageRawHtmlRequestInfo
object
2 properties
OnPageWaterfallRequestInfo
object
3 properties
SslInfo
object
6 properties
OnPageTasksReadyTaskInfo
object
Contacts
object
2 properties
OnPageLighthouseAuditsResultInfo
object
1 property
OnPageLighthouseTaskGetJsonTaskInfo
object
OnPageLighthouseTaskPostTaskInfo
object
MessageInfo
object
2 properties
OnPageRedirectChainsResponseInfo
object
BaseOnPageResourceItem
object
15 properties
OnPageResourcesRequestInfo
object
9 properties
MicrodataInspectionInfo
object
2 properties
OnPageContentParsingRequestInfo
object
3 properties
OnPageDuplicateContentResponseInfo
object
OnPageRedirectChainsItem
object
2 properties
OnPagePagesResponseInfo
object
OnPageLighthouseAuditsResponseInfo
object
OnPagePagesTaskInfo
object
OnPageErrorsResultInfo
object
10 properties
PageMetaInfo
object
30 properties
OnPagePagesByResourceResponseInfo
object
OnPageIdListRequestInfo
object
6 properties
DuplicatePageInfo
object
2 properties
OnPageLinksResultInfo
object
7 properties
OnPageMicrodataInfoItem
object
2 properties
BaseResponseInfo
object
7 properties
OnPageContentParsingLiveRequestInfo
object
15 properties
OnPageLighthouseAuditsTaskInfo
object
OnPageErrorsRequestInfo
object
5 properties
OnPageIdListResultInfo
object
7 properties
OnPageResourceLocationInfo
object
3 properties
OnPageLighthouseVersionsResponseInfo
object
OnPageLighthouseTaskPostRequestInfo
object
9 properties
ContentParsingElement
object
5 properties
PageTiming
object
12 properties
OnPagePagesByResourceResultInfo
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from DataForSEO 11
Other APIs DataForSEO publishes across the network.
DataForSEO AiOptimization API
DataForSEO AppData API
DataForSEO Appendix API
DataForSEO Backlinks API
DataForSEO BusinessData API
DataForSEO ContentAnalysis API
DataForSEO DataforseoLabs API
DataForSEO DomainAnalytics API
DataForSEO KeywordsData API
DataForSEO Merchant API
DataForSEO Serp API
#OnPage
Where this information came from
This is an independent, third-party profile of DataForSEO OnPage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.