Data API / DataForSEO / DataForSEO Labs
SERP Competitors
The domains ranking alongside you for a set of keywords, with how many they share. Returns se_type, seed_keywords, total_count, items_count and items. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ These are search competitors, decided by shared rankings. The link-graph equivalent is post_dataforseo_backlinks_competitors_live, and the two lists often disagree - which is itself informative.
Parameters
No path, query, or header parameters.
Request body
keywordsstring[]Requiredkeywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_namestringOptionalfull name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom
location_codeintegerOptionalunique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840
language_namestringOptionalfull name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English
language_codestringOptionalunique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en
include_subdomainsbooleanOptionalindicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true
item_typesstring[]Optionalsearch results type indicates type of search results included in the response optional field possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]
limitintegerOptionalthe maximum number of returned domains optional field default value: 100 maximum value: 1000
offsetintegerOptionaloffset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains
filtersarrayOptionalarray of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , , >, >=, =, , in, not_in, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["median_position","in",[1,10]] [["median_position","in",[1,10]],"and",["domain","not_like","%wikipedia.org%"]] [["domain","not_like","%wikipedia.org%"], "and", [["relevant_serp_items",">",0],"or",["median_position","in",[1,10]]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Optionalresults sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order the comma is used as a separator example: ["avg_position,asc"] default rule: ["rating,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["avg_position,asc","etv,desc"]
tagstringOptionaluser-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
Example request
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/serp_competitors/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keywords": [
"<string>"
],
"location_name": "<string>",
"location_code": 0,
"language_name": "<string>",
"language_code": "<string>",
"include_subdomains": false,
"item_types": [
"<string>"
],
"limit": 0
}'Response
Response fields
versionstringOptionalthe current version of the API
status_codeintegerOptionalgeneral status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringOptionalgeneral informational message you can find the full list of general informational messages here
timestringOptionalexecution time, seconds
costnumberOptionaltotal tasks cost, USD
tasks_countintegerOptionalthe number of tasks in the tasks array
tasks_errorintegerOptionalthe number of tasks in the tasks array returned with an error
tasksstring[]Optionalarray of tasks
idstringOptionaltask identifier unique task identifier in our system in the UUID format
status_codeintegerOptionalstatus code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringOptionalinformational message of the task you can find the full list of general informational messages here
timestringOptionalexecution time, seconds
costnumberOptionalcost of the task, USD
result_countintegerOptionalnumber of elements in the result array
pathstring[]OptionalURL path
dataobjectOptionalcontains the same parameters that you specified in the POST request
resultstring[]Optionalarray of results
se_typestringOptionalsearch engine type
seed_keywordsstring[]Optionalkeywords specified in the request keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)
location_codeintegerOptionallocation code in a POST array if there is no data, then the value is null
language_codestringOptionallanguage code in a POST array if there is no data, then the value is null
total_countintegerOptionalthe total amount of results in our database relevant to your request
items_countintegerOptionalthe number of results returned in the items array
itemsstring[]Optionalcontains detected SERP competitors and related data
se_typestringOptionalsearch engine type
domainstringOptionaldomain name of the detected SERP competitor
avg_positionintegerOptionalthe average position of the domain for the specified keywords the arithmetic mean of values in the keywords_positions array
median_positionintegerOptionalthe median position of the domain for the specified keywords the median of the values in the keywords_positions array
ratingintegerOptionalthe margin between the greatest possible and actual keyword positions represents the relative visibility rate of the domain in SERP for the specified keywords calculated as sum(100-keywords_positions)
etvnumberOptionalestimated traffic volume represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords’ search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in this help center article
keywords_countintegerOptionalthe number of specified keywords the domain has positions for in SERPs
visibilitynumberOptionalSERP visibility rate represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from 1 to 10 are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from 11 to 20 have the fixed visibility index of 0.05 keywords with positions from 20 to 100 have the visibility index equal to 0
relevant_serp_itemsintegerOptionalthe number of SERP elements relevant to the domain represents the number of search results in SERP relevant to the domain for the specified keywords
keywords_positionsobjectOptionalkeyword positions SERP positions the related domain holds in SERP for the specified keywords