NAVNavbar
Logo
php python csharp java

Subdomains

‌‌
This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions.

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(
   "target" => "dataforseo.com",
   "language_name" => "English",
   "location_code" => 2840,
   "filters" => [
      ["metrics.organic.pos_1", "<>", 0],
      "or",
      ["metrics.organic.pos_2_3", "<>", 0]
   ]
);
try {
   // POST /v3/dataforseo_labs/subdomains/live
   $result = $client->post('/v3/dataforseo_labs/subdomains/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.20200312",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.5739 sec.",
  "cost": 0.0001,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "03130845-0696-0130-0000-96c5fc587ad4",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.5053 sec.",
      "cost": 0.0001,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "subdomains",
        "live"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "subdomains",
        "target": "dataforseo.com",
        "language_name": "English",
        "location_code": 2840,
        "filters": [
          [
            "metrics.organic.pos_1",
            "<>",
            0
          ],
          "or",
          [
            "metrics.organic.pos_2_3",
            "<>",
            0
          ]
        ],
        "limit": 5
      },
      "result": [
        {
          "target": "dataforseo.com",
          "location_code": 2840,
          "language_code": "en",
          "total_count": 4,
          "items_count": 1,
          "items": [
            {
              "subdomain": "dataforseo.com",
              "metrics": {
                "organic": {
                  "pos_1": 3,
                  "pos_2_3": 4,
                  "pos_4_10": 23,
                  "pos_11_20": 41,
                  "pos_21_30": 77,
                  "pos_31_40": 121,
                  "pos_41_50": 119,
                  "pos_51_60": 134,
                  "pos_61_70": 148,
                  "pos_71_80": 130,
                  "pos_81_90": 133,
                  "pos_91_100": 93,
                  "etv": 1004.582271469757,
                  "impressions_etv": 28.86421124637127,
                  "count": 1011,
                  "estimated_paid_traffic_cost": 6274.030524849426
                },
                "paid": {
                  "pos_1": 5,
                  "pos_2_3": 0,
                  "pos_4_10": 0,
                  "pos_11_20": 0,
                  "pos_21_30": 0,
                  "pos_31_40": 0,
                  "pos_41_50": 0,
                  "pos_51_60": 0,
                  "pos_61_70": 0,
                  "pos_71_80": 0,
                  "pos_81_90": 0,
                  "pos_91_100": 0,
                  "etv": 423.044997215271,
                  "impressions_etv": 0,
                  "count": 5,
                  "estimated_paid_traffic_cost": 1407.9778957366943
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

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
target string domain
required field
the domain name of the target website
the domain should be specified without https:// and www.
location_name string full name of the location
optional field
if you use this field, you don’t need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
United Kingdom
location_code integer location code
optional field
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 by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
2840
language_name string full name of the language
optional field
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 by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
English
language_code string language code
optional field
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 by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
en
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
example:
["metrics.paid.count",">",0]

[["metrics.paid.count",">",0],"and",["metrics.paid.etv",">","50"]]

[["metrics.organic.count",">","10"],
"and",
[["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]

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:
["metrics.organic.pos_11_20,asc"]
default rule:
["metrics.organic.count,desc"]
note that you can set no more than three sorting rules in a single request
you should use comma to separate several sorting rules
example:
["metrics.organic.pos_11_20,asc","metrics.paid.etv,desc"]
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
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
            target string domain in a POST array
            location_code integer location code in a POST array
            language_code string language code in a POST array
            total_count integer 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 subdomains and related data
                subdomain field returned subdomain
                metrics array ranking data relevant to subdomain
                    paid array ranking and traffic data from paid search
                        pos_1 integer number of paid SERPs where the subdomain ranks #1
                        pos_2_3 integer number of paid SERPs where the subdomain ranks #2-3
                        pos_4_10 integer number of paid SERPs where the subdomain ranks #4-10
                        pos_11_20 integer number of paid SERPs where the subdomain ranks #11-20
                        pos_21_30 integer number of paid SERPs where the subdomain ranks #21-30
                        pos_31_40 integer number of paid SERPs where the subdomain ranks #31-40
                        pos_41_50 integer number of paid SERPs where the subdomain ranks #41-50
                        pos_51_60 integer number of paid SERPs where the subdomain ranks #51-60
                        pos_61_70 integer number of paid SERPs where the subdomain ranks #61-70
                        pos_71_80 integer number of paid SERPs where the subdomain ranks #71-80
                        pos_81_90 integer number of paid SERPs where the subdomain ranks #81-90
                        pos_91_100 integer number of paid SERPs where the subdomain ranks #91-100
                        etv float estimated traffic volume
estimated paid monthly traffic to the subdomain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the subdomain ranks for
                        impressions_etv float estimated traffic volume based on impressions
estimated paid monthly traffic to the subdomain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords the subdomain ranks for
                        count integer total count of paid SERPs that contain the subdomain
                        estimated_paid_traffic_cost float estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic based on etv and cpc values
                    organic array ranking and traffic data from organic search
                        pos_1 integer number of organic SERPs where the subdomain ranks #1
                        pos_2_3 integer number of organic SERPs where the subdomain ranks #2-3
                        pos_4_10 integer number of organic SERPs where the subdomain ranks #4-10
                        pos_11_20 integer number of organic SERPs where the subdomain ranks #11-20
                        pos_21_30 integer number of organic SERPs where the subdomain ranks #21-30
                        pos_31_40 integer number of organic SERPs where the subdomain ranks #31-40
                        pos_41_50 integer number of organic SERPs where the subdomain ranks #41-50
                        pos_51_60 integer number of organic SERPs where the subdomain ranks #51-60
                        pos_61_70 integer number of organic SERPs where the subdomain ranks #61-70
                        pos_71_80 integer number of organic SERPs where the subdomain ranks #71-80
                        pos_81_90 integer number of organic SERPs where the subdomain ranks #81-90
                        pos_91_100 integer number of organic SERPs where the subdomain ranks #91-100
                        etv float estimated traffic volume
estimated organic monthly traffic to the subdomain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the subdomain ranks for
                        impressions_etv float estimated traffic volume based on impressions
estimated organic monthly traffic to the subdomain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords the subdomain ranks for
                        count integer total count of organic SERPs that contain the subdomain
                        estimated_paid_traffic_cost float estimated cost of monthly search traffic
represents the estimated cost of organic monthly traffic based on etv and cpc values

‌‌