The OnPage API from DataForSEO — 30 operation(s) for onpage.
openapi: 3.0.1
info:
title: DataForSEO AiOptimization OnPage API
description: DataForSEO API is the starting point on your journey towards building powerful SEO software. With DataForSEO you can get all the data you need to build an efficient application while also saving your time and budget. DataForSEO API is using the REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages.
version: 1.0.0
servers:
- url: https://api.dataforseo.com
- url: https://sandbox.dataforseo.com
tags:
- name: OnPage
paths:
/v3/on_page/id_list:
post:
tags:
- OnPage
description: '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 please visit ''https://docs.dataforseo.com/v3/on_page/id_list/?bash'''
operationId: OnPageIdList
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageIdListRequestInfo'
nullable: true
example:
- datetime_from: '2026-04-12 04:39:39 +00:00'
datetime_to: '2026-04-14 04:39:39 +00:00'
limit: 100
offset: 0
sort: desc
include_metadata: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageIdListResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/errors:
post:
tags:
- OnPage
description: '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/on_page/errors/?bash'''
operationId: OnPageErrors
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageErrorsRequestInfo'
nullable: true
example:
- limit: 10
offset: 0
filtered_function: pingback_url
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageErrorsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/force_stop:
post:
tags:
- OnPage
description: '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 be stopped. You will still be able to obtain the data on pages that have been scanned until the crawling process was stopped.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/force_stop/?bash'''
operationId: ForceStop
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageForceStopRequestInfo'
nullable: true
example:
- id: 08121600-1535-0216-0000-37b4c7a34453
- id: 08121600-1535-0216-0000-d6a5000b6897
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageForceStopResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/available_filters:
get:
tags:
- OnPage
description: '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.
Here you will find all the necessary information about filters and thresholds that can be used with DataForSEO OnPage API endpoints.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/filters_and_thresholds/?bash'''
operationId: OnPageAvailableFilters
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageAvailableFiltersResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/task_post:
post:
tags:
- OnPage
description: '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, duplicate content, image tags, response codes, and other parameters on every page. You can find the full list of OnPage API check-up parameters in the Pages section.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/task_post/?bash'''
operationId: TaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageTaskPostRequestInfo'
nullable: true
example:
- target: dataforseo.com
max_crawl_pages: 10
load_resources: true
enable_javascript: true
custom_js: meta = {}; meta.url = document.URL; meta;
tag: some_string_123
pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/tasks_ready:
get:
tags:
- OnPage
description: '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/on_page-tasks_ready/?bash'''
operationId: OnPageTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/summary/{id}:
get:
tags:
- OnPage
description: '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 use for receiving detailed data for each of the found issues.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/summary/?bash'''
operationId: Summary
parameters:
- name: id
in: path
description: 'task identifier
required field
you can get this ID in the response of the Task POST endpoint
example:
“07131248-1535-0216-1000-17384017ad04”'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageSummaryResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/pages:
post:
tags:
- OnPage
description: '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 on how well your pages are optimized for search.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/pages/?bash'''
operationId: Pages
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPagePagesRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
filters:
- - resource_type
- '='
- html
- and
- - meta.scripts_count
- '>'
- 40
order_by:
- meta.content.plain_text_word_count,desc
limit: 10
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPagePagesResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/pages_by_resource:
post:
tags:
- OnPage
description: '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 the URL of a resource using the Resources endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/page_by_resource/?bash'''
operationId: PagesByResource
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPagePagesByResourceRequestInfo'
nullable: true
example:
- id: 02241700-1535-0216-0000-034137259bc1
url: https://www.etsy.com/about/jobs.workco2018.js?
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPagePagesByResourceResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/resources:
post:
tags:
- OnPage
description: '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.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/resources/?bash'''
operationId: Resources
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageResourcesRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
filters:
- - resource_type
- '='
- image
- and
- - size
- '>'
- 100000
order_by:
- size,desc
limit: 10
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageResourcesResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/duplicate_tags:
post:
tags:
- OnPage
description: '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.dataforseo.com/v3/on_page/duplicate_tags/?bash'''
operationId: DuplicateTags
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageDuplicateTagsRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
type: duplicate_description
limit: 10
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageDuplicateTagsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/duplicate_content:
post:
tags:
- OnPage
description: '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 indicates how similar the compared pages are.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/duplicate_content/?bash'''
operationId: DuplicateContent
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageDuplicateContentRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
url: https://www.etsy.com/
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageDuplicateContentResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/links:
post:
tags:
- OnPage
description: '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 webpage;
image – links that point to an image;
canonical – links that point to a canonical page;
meta – links with meta http-equiv=refresh ;
alternate – links with link rel="alternate" pointing to an alternative version of a webpage ;
redirect – links with redirect status.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/links/?bash'''
operationId: Links
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLinksRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
page_from: /apis/google-trends-api
filters:
- - dofollow
- '='
- true
- and
- - direction
- '='
- external
limit: 10
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLinksResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/redirect_chains:
post:
tags:
- OnPage
description: '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 redirects is considered a redirect chain. Sometimes, if page B redirects back to page A, the redirect chain becomes closed and is considered a redirect loop.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/redirect_chains/?bash'''
operationId: RedirectChains
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageRedirectChainsRequestInfo'
nullable: true
example:
- id: 03051327-4536-0216-1000-3b458a2cfcca
url: https://test_rdr.dataforseo.com/a/
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageRedirectChainsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/non_indexable:
post:
tags:
- OnPage
description: '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://docs.dataforseo.com/v3/on_page/non_indexable/?bash'''
operationId: NonIndexable
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageNonIndexableRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
filters:
- - reason
- '='
- robots_txt
- and
- - url
- like
- '%go%'
limit: 10
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageNonIndexableResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/waterfall:
post:
tags:
- OnPage
description: '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 to load page resources, and so on.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/waterfall/?bash'''
operationId: Waterfall
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageWaterfallRequestInfo'
nullable: true
example:
- id: 08101204-0696-0216-0000-644a7b21a48a
url: https://dataforseo.com/tag/broken-links
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageWaterfallResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/keyword_density:
post:
tags:
- OnPage
description: '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 this API call.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/keyword_density/?bash'''
operationId: KeywordDensity
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageKeywordDensityRequestInfo'
nullable: true
example:
- id: 09101923-1535-0216-0000-2389a8854b70
url: https://dataforseo.com/
keyword_length: 2
filters:
- frequency
- '>'
- 5
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageKeywordDensityResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/microdata:
post:
tags:
- OnPage
description: '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 of its validation.
To use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/microdata/?bash'''
operationId: Microdata
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageMicrodataRequestInfo'
nullable: true
example:
- id: 02241700-1535-0216-0000-034137259bc1
url: https://dataforseo.com/apis
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageMicrodataResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/raw_html:
post:
tags:
- OnPage
description: 'This endpoint returns the HTML of a page you indicate in the request.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/raw_html/?bash'''
operationId: RawHtml
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageRawHtmlRequestInfo'
nullable: true
example:
- id: 07281559-0695-0216-0000-c269be8b7592
url: https://dataforseo.com/apis
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageRawHtmlResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/page_screenshot:
post:
tags:
- OnPage
description: '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 visit ''https://docs.dataforseo.com/v3/on_page/page_screenshot/?bash'''
operationId: PageScreenshot
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPagePageScreenshotRequestInfo'
nullable: true
example:
- url: https://dataforseo.com/apis
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPagePageScreenshotResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/content_parsing:
post:
tags:
- OnPage
description: '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 please visit ''https://docs.dataforseo.com/v3/on_page/content_parsing/?bash'''
operationId: ContentParsing
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageContentParsingRequestInfo'
nullable: true
example:
- url: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
id: 11161551-1535-0216-0000-500b3f307f92
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageContentParsingResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/content_parsing/live:
post:
tags:
- OnPage
description: '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 please visit ''https://docs.dataforseo.com/v3/on_page/content_parsing/live/?bash'''
operationId: ContentParsingLive
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageContentParsingLiveRequestInfo'
nullable: true
example:
- url: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageContentParsingLiveResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/instant_pages:
post:
tags:
- OnPage
description: '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/on_page/instant_pages/?bash'''
operationId: InstantPages
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageInstantPagesRequestInfo'
nullable: true
example:
- url: https://dataforseo.com/blog
enable_javascript: true
custom_js: meta = {}; meta.url = document.URL; meta;
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageInstantPagesResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/lighthouse/languages:
get:
tags:
- OnPage
description: '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.
for more info please visit ''https://docs.dataforseo.com/v3/on_page/lighthouse/languages/?bash'''
operationId: LighthouseLanguages
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLighthouseLanguagesResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/lighthouse/audits:
get:
tags:
- OnPage
description: '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/on_page/lighthouse/audits/?bash'''
operationId: LighthouseAudits
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLighthouseAuditsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/lighthouse/versions:
get:
tags:
- OnPage
description: '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/on_page/lighthouse/versions/?bash'''
operationId: LighthouseVersions
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLighthouseVersionsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/on_page/lighthouse/task_post:
post:
tags:
- OnPage
description: '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/on_page/lighthouse/task_post/?bash'''
operationId: LighthouseTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLighthouseTaskPostRequestInfo'
nullable: true
example:
- url: https://dataforseo.com
for_mobile: true
tag: some_string_123
pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/OnPageLighthouseTaskPostResponseInfo'
nullable
# --- truncated at 32 KB (233 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dataforseo/refs/heads/main/openapi/dataforseo-onpage-api-openapi.yml