NAVNavbar
Logo
php python csharp java

SERP Competitors


This endpoint will provide you with a list of domains rankings for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
   "keywords" => [
      "phone",
      "watch"
   ],
   "language_name" => "English",
   "location_code" => 2840,
   "filters" => [
      ["relevant_serp_items", ">", 0],
      "or",
      ["median_position", "in", [ 1, 10 ]]
   ]
);
try {
   // POST /v3/dataforseo_labs/serp_competitors/live
   $result = $client->post('/v3/dataforseo_labs/serp_competitors/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "\n";
   print "HTTP code: {$e->getHttpCode()}\n";
   print "Error code: {$e->getCode()}\n";
   print "Message: {$e->getMessage()}\n";
   print  $e->getTraceAsString();
   echo "\n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20200317",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.2667 sec.",
  "cost": 0.0103,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "03171545-1535-0128-0000-26def0a403f5",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.1437 sec.",
      "cost": 0.0103,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "serp_competitors",
        "live"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "serp_competitors",
        "keywords": [
          "reuse iphone",
          "iphone adult"
        ],
        "language_name": "English",
        "location_code": 2840,
        "include_subdomains": false,
        "limit": 3
      },
      "result": [
        {
          "seed_keywords": [
            "reuse iphone",
            "iphone adult"
          ],
          "location_code": 2840,
          "language_code": "en",
          "total_count": 98,
          "items_count": 3,
          "items": [
            {
              "domain": "cnet.com",
              "avg_position": 2,
              "median_position": 1,
              "rating": 196,
              "etv": 8.026,
              "keywords_count": 1,
              "visibility": 1.8,
              "relevant_serp_items": 2,
              "keywords_positions": {
                "reuse iphone": [
                  1,
                  3
                ]
              }
            },
            {
              "domain": "google.com",
              "avg_position": 20.5,
              "median_position": 20,
              "rating": 159,
              "etv": 0.094,
              "keywords_count": 1,
              "visibility": 0.05,
              "relevant_serp_items": 2,
              "keywords_positions": {
                "reuse iphone": [
                  20,
                  21
                ]
              }
            },
            {
              "domain": "ifixit.com",
              "avg_position": 31.5,
              "median_position": 29,
              "rating": 137,
              "etv": 0.08399999999999999,
              "keywords_count": 1,
              "visibility": null,
              "relevant_serp_items": 2,
              "keywords_positions": {
                "reuse iphone": [
                  29,
                  34
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.

You can specify the number of results you want to retrieve, filter and sort them.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
keywords array keywords array
required field
the results will be based on the keywords you specify in this array
we use UTF-8 encoding
all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
keywords will be converted to the lowercase format
a keyword should be at least 3 characters long
you can specify the maximum of 200 keywords
location_name string full name of the location
optional field if you specify location_code
if you use this field, you don’t need to specify 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_code integer unique location identifier
optional field if you specify location_name
if you use this field, you don’t need to specify location_name
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_name string full name of the language
optional field if you specify language_code
if you use this field, you don’t need to specify 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_code string unique language identifier
optional field if you specify language_name
if you use this field, you don’t need to specify language_name
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_subdomains boolean indicates if the subdomains will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true
type string search results type
optional field
can take the following values: organic, paid
default value: organic
limit integer the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000
offset integer offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
filters array array 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:
<, <=, >, >=, =, <>, in, not_in, like, not_like
you can use the % operator with like and not_like 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

order_by array results 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"]
tag string user-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 array of the response

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.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status 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_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data array contains the same parameters that you specified in the POST request
        result array array of results
            seed_keywords string keyword
keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
            location_code integer location code in a POST array
if there is no data, then the value is null
            language_code string language code in a POST array
if there is no data, then the value is null
            total_count integer the total amount of results in our database relevant to your request
            items_count integer the number of results returned in the items array
            items array contains detected SERP competitors and related data
                domain string domain name of the detected SERP competitor
                avg_position integer the average position of the domain for the specified keywords
the arithmetic mean of values in the keywords_positions array
                median_position integer the median position of the domain for the specified keywords
the median of the values in the keywords_positions array
                rating integer the 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)
                etv float estimated 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
                keywords_count integer the number of specified keywords the domain has positions for in SERPs
                visibility float SERP 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_items integer the 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_positions array keyword positions
SERP positions the related domain holds in SERP for the specified keywords

‌‌