NAVNavbar
Logo
cURL php NodeJS Python cSharp

Get {{up_se_name}} {{up_se_type}} SERP Advanced Results by id

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/';
try {
    // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
    $client = new RestClient($api_url, null, 'login', 'password');
} 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";
    exit();
}
try {
    $result = array();
    // #1 - using this method you can get a list of completed tasks
    // GET /v3/serp/{{low_se_name}}/{{low_se_type}}/tasks_ready
    // in addition to '{{low_se_name}}' and '{{low_se_type}}' you can also set other search engine and type parameters
    // the full list of possible parameters is available in documentation
    $tasks_ready = $client->get('/v3/serp/{{low_se_name}}/{{low_se_type}}/tasks_ready');
    // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
    if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) {
        foreach ($tasks_ready['tasks'] as $task) {
            if (isset($task['result'])) {
                foreach ($task['result'] as $task_ready) {
                    // #2 - using this method you can get results of each completed task
                    // GET /v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/advanced/$id
                    if (isset($task_ready['endpoint_advanced'])) {
                        $result[] = $client->get($task_ready['endpoint_advanced']);
                    }
                    // #3 - another way to get the task results by id
                    // GET /v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/advanced/$id
                    /*
                    if (isset($task_ready['id'])) {
                        $result[] = $client->get('/v3/serp/{{low_se_name}}/{{low_se_type}}/task_get/advanced/' . $task_ready['id']);
                    }
                    */
                }
            }
        }
    }
    print_r($result);
    // do something with 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.20200923",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.0733 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "10061219-1535-0066-0000-268f221de517",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0193 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "serp",
        "google",
        "news",
        "task_get",
        "advanced",
        "10061219-1535-0066-0000-268f221de517"
      ],
      "data": {
        "api": "serp",
        "function": "task_get",
        "se": "google",
        "se_type": "news",
        "language_code": "en",
        "location_code": "2840",
        "keyword": "brexit",
        "device": "desktop",
        "calculate_rectangles": true,
        "depth": 5,
        "os": "windows"
      },
      "result": [
        {
          "keyword": "brexit",
          "type": "news",
          "se_domain": "google.com",
          "location_code": 2840,
          "language_code": "en",
          "check_url": "https://www.google.com/search?q=brexit&num=5&hl=en&gl=US&gws_rd=cr&tbm=nws&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc&ie=UTF-8&oe=UTF-8",
          "datetime": "2020-10-06 09:20:45 +00:00",
          "spell": null,
          "item_types": [
            "news_search"
          ],
          "se_results_count": 87400000,
          "items_count": 4,
          "items": [
            {
              "type": "news_search",
              "rank_group": 1,
              "rank_absolute": 1,
              "xpath": "/html[1]/body[1]/div[7]/div[2]/div[9]/div[1]/div[2]/div[1]/div[2]/div[2]/div[1]/div[1]/div[2]",
              "domain": "www.reuters.com",
              "title": "UK's Johnson doesn't want a no-deal Brexit but can live with it",
              "url": "https://www.reuters.com/article/britain-eu-idUSKBN26P0HR",
              "image_url": null,
              "snippet": "British Prime Minister Boris Johnson does not particularly wish for the \nBrexit transition period to end without a new trade deal in place but ...",
              "time_published": "1 day ago",
              "timestamp": "2020-10-05 09:20:45 +00:00",
              "rectangle": {
                "x": 166,
                "y": 551,
                "width": 600,
                "height": 168
              }
            },
            {
              "type": "news_search",
              "rank_group": 2,
              "rank_absolute": 2,
              "xpath": "/html[1]/body[1]/div[7]/div[2]/div[9]/div[1]/div[2]/div[1]/div[2]/div[2]/div[1]/div[1]/div[3]",
              "domain": "www.bloomberg.com",
              "title": "City of London's Brexit Departures Are Speeding Up",
              "url": "https://www.bloomberg.com/view/articles/2020-10-06/brexit-news-the-city-of-london-s-banker-exodus-is-gaining-momentum",
              "image_url": null,
              "snippet": "Whether there's a Brexit trade deal or not, the big investment banks are \nshifting significant resources to the EU.",
              "time_published": "3 hours ago",
              "timestamp": "2020-10-06 06:20:45 +00:00",
              "rectangle": {
                "x": 166,
                "y": 735,
                "width": 600,
                "height": 146
              }
            },
            {
              "type": "news_search",
              "rank_group": 3,
              "rank_absolute": 3,
              "xpath": "/html[1]/body[1]/div[7]/div[2]/div[9]/div[1]/div[2]/div[1]/div[2]/div[2]/div[1]/div[1]/div[4]",
              "domain": "www.independent.co.uk",
              "title": "EU says that no-deal Brexit becoming ever more likely",
              "url": "https://www.independent.co.uk/news/world/americas/us-politics/eu-says-nodeal-brexit-becoming-ever-more-likely-eu-trade-deal-two-official-brexit-b831295.html",
              "image_url": null,
              "snippet": "A top European Union official dealing with the United Kingdom says that a \ncliff-edge rupture between the two without even a basic trade deal by ...",
              "time_published": "8 mins ago",
              "timestamp": "2020-10-06 09:12:45 +00:00",
              "rectangle": {
                "x": 166,
                "y": 897,
                "width": 600,
                "height": 146
              }
            },
            {
              "type": "news_search",
              "rank_group": 4,
              "rank_absolute": 4,
              "xpath": "/html[1]/body[1]/div[7]/div[2]/div[9]/div[1]/div[2]/div[1]/div[2]/div[2]/div[1]/div[1]/div[5]",
              "domain": "fortune.com",
              "title": "What’s more destructive than COVID-19? The twin shocks of a pandemic and \nno-deal Brexit, Germany warns",
              "url": "https://fortune.com/2020/10/05/germany-brexit-no-deal-covid-19-pandemic/",
              "image_url": null,
              "snippet": "The double-whammy of the COVID-19 pandemic and a no-deal Brexit would lop \n6% off the U.K.'s GDP over the next decade, a new study ...",
              "time_published": "18 hours ago",
              "timestamp": "2020-10-05 15:20:45 +00:00",
              "rectangle": {
                "x": 166,
                "y": 1059,
                "width": 600,
                "height": 168
              }
            }
          ]
        }
      ]
    }
  ]
}

Description of the fields for sending a request:

Field name Type Description
id string task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time


‌‌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
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
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 object contains the same parameters that you specified in the POST request
        result array array of results
            keyword string keyword received in a POST array
the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
            type string search engine type in a POST array
            se_domain string search engine domain in a POST array
            location_code integer location code in a POST array
            language_code string language code in a POST array
            check_url string direct URL to search engine results
you can use it to make sure that we provided accurate results
            datetime string date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00
            spell object autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection
                keyword string keyword obtained as a result of search engine autocorrection
the results will be provided for the corrected keyword
                type string type of autocorrection
possible values:
did_you_mean, showing_results_for, no_results_found_for
            item_types array types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
news_search
            se_results_count integer total number of results in SERP
            items_count integer the number of results returned in the items array
            items array elements of search results found in SERP
            ‘Google News’ SERP element
                type string type of element = ‘news_search’
                rank_group integer group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                rank_absolute integer absolute rank in SERP
absolute position among all the elements in SERP
                xpath string the XPath of the element
                domain string domain name of the result in SERP
                title string title of the result in SERP
                url string URL of the result in SERP
                snippet string snippet of the result in SERP
                time_published string indicates the time the result was published
                timestamp string date and time when the news was published
in the format “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:
2019-11-15 12:57:46 +00:00
                rectangle object rectangle parameters
contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
equals null if calculate_rectangles in the POST request is not set to true
                    x integer x-axis coordinate
x-axis coordinate of the top-left corner of the result’s snippet, where top-left corner of the screen is the origin
                    y integer y-axis coordinate
y-axis coordinate of the top-left corner of the result’s snippet, where top-left corner of the screen is the origin
                    width integer width of the element in pixels
                    height integer height of the element in pixels

‌‌