NAVNavbar
Logo
php python csharp java

Live {{up_se_name}} {{up_se_type}} SERP

‌‌
Live {{up_se_name}} {{up_se_type}} SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location.

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();
}
$post_array = array();
// You can set only one task at a time
$post_array[] = array(
	"language_code" => "en",
	"location_code" => 2840,
	"keyword" => mb_convert_encoding("albert einstein", "UTF-8")
);
try {
	// POST /v3/serp/{{low_se_name}}/{{low_se_type}}/live/advanced
	// 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
	$result = $client->post('/v3/serp/{{low_se_name}}/{{low_se_type}}/live/advanced', $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": "3.20191128",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.3059 sec.",
  "cost": 0.05,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11151456-0696-0066-0000-002a5915da37",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0952 sec.",
      "cost": 0.05,
      "result_count": 1,
      "path": [
        "v3",
        "serp",
        "{{low_se_name}}",
        "{{low_se_type}}",
        "live",
        "advanced"

      ],
      "data": {
        "api": "serp",
        "function": "live",
        "se": "{{low_se_name}}",
        "se_type": "{{low_se_type}}",
        "language_code": "en",
        "location_code": 2840,
        "keyword": "albert einstein",
        "tag": "tag1",
        "device": "desktop",
        "os": "windows"
      },
      "result": [
        {
          "keyword": "albert enstein",
          "type": "{{low_se_type}}",
          "se_domain": "{{low_se_name}}.com",
          "location_code": 2840,
          "language_code": "en",
          "check_url": "https://google.com/maps/search/albert+enstein/@37.09024,-95.712891,4z",
          "datetime": "2019-11-15 12:57:46 +00:00",
          "target_rankings": null,
          "spell": null,
          "item_types": [
            "maps_search"
          ],
          "se_results_count": 85,
          "items_count": 1,
          "items": [
            {
              "type": "maps_search",
              "rank_group": 1,
              "rank_absolute": 1,
              "domain": "openculture.com",
              "title": "Marie-Curie / Albert-Einstein",
              "url": "http://www.openculture.com/2017/12/read-the-dont-let-the-bastards-get-you-down-letter-that-albert-einstein-sent-to-marie-curie-during-a-time-of-personal-crisis-1911.html",
              "rating": {
                  "rating_type": "Max5",
                  "value": 4.5,
                  "votes_count": 4,
                  "rating_max": null
            }
          ]
        }
      ]
    }
  ]
}

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, with each POST call containing no more than 100 tasks.

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
url string direct URL of the search query
optional field
you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
example:
https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
keyword string keyword
required field
you can specify up to 700 symbols in the keyword filed
all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
if you need to use the “%” symbol for your keyword, please specify it as “%25”;
if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’ the charge per task will be multiplied by 5
location_name string full name of search engine location
optional field if you specify location_code or location_coordinate
if you use this field, you don’t need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:
London,England,United Kingdom
location_code integer search engine location code
optional field if you specify location_name or location_coordinate
if you use this field, you don’t need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
example:
2840
location_coordinate string GPS coordinates of a location
optional field if you specify location_name or location_code
if you use this field, you don’t need to specify location_name or location_code
location_coordinate parameter should be specified in the “latitude,longitude,radius” format
the maximum number of decimal digits for “latitude” and “longitude”: 7
the minimum value for “radius”: 199.9
example:
52.6178549,-155.352142,200
language_name string full name of search engine 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 locations of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:
English
language_code string search engine language code
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 locations of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
example:
en
os string device operating system
optional field
note that this API provides results for desktop only
choose from the following values: windows, macos
default value: windows
target string domain or URL
optional field
note that the results of target-specific tasks will only include SERP elements that contain the url string;
the results will be provided in the target_rankings array;
if a string contains a domain, you will recieve SERP elements that contain the specified domain in the URL string;
if a string contains a URL, you will recieve SERP elements that have URL strings identical to the specified URL;
example:
example.com (standard search)
example.com/example (search for the exact URL)
se_domain string search engine domain
optional field
we choose the relevant search engine domain automatically according to the location and language you specify
however, you can set a custom search engine domain in this field
example:
google.co.uk, google.com.au, google.de, etc.
depth integer parsing depth
optional field
number of results in SERP
default value: 100
max value: 700
search_param string additional parameters of the search query
optional field
for example, if you want to disable auto-correction of the search query misspelling for google, you should use the “&nfpr=1” parameter
get the list of available parameters and additional details here.
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
            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 exact results
            datetime string date and time when the result was received
in the format “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”
example:
2019-11-15 12:57:46 +00:00
            target_rankings array SERP positions of the targeted domain or URL
contains organic, paid and advanced SERP elements linked to the domain or the URL specified in the target string of a task
                type integer type of element
possible types: maps_search
                rank_group integer group rank in SERP for the targeted domain or URL
the position in the group of elements; a group is formed according to the type field
                rank_absolute integer absolute rank in SERP for the targeted domain or URL
absolute position among all the elements in SERP
                url string the URL of the SERP result linked to the targeted domain or URL
            spell array 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:
maps_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 Maps’ SERP element
                type string type of element = ‘maps_search’
                rank_group integer group rank in SERP
the position in the group of elements; a group is formed according to the type field
                rank_absolute integer absolute rank in SERP
absolute position among all the elements in SERP
                domain string domain in the SERP element
                title string title of the result in SERP
                url string relevant URL in SERP
                rating array the element’s rating
the popularity rate based on reviews and displayed in SERP
                    rating_type string the type of rating
here you can find the following elements: Max5, Percents, CustomMax
                    value integer the value of the rating
                    votes_count integer the amount of feedback
                    rating_max integer the maximum value for a rating_type

‌‌