Live {{up_se_name}} {{normal_se_type}} SERP HTML
Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location
and language
.
Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location
and language
.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
<?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-access $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 ); try { // POST /v3/serp/{{low_se_name}}/{{low_se_type}}/live/html // 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/html', $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.20200130", "status_code": 20000, "status_message": "Ok.", "time": "7.7543 sec.", "cost": 0.003, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "01301613-1535-0140-0000-c64ff6de0501", "status_code": 20000, "status_message": "Ok.", "time": "7.6463 sec.", "cost": 0.003, "result_count": 1, "path": [ "v3", "serp", "{{low_se_name}}", "{{low_se_type_under}}", "live", "html" ], "data": { "api": "serp", "function": "live", "se": "{{low_se_name}}", "se_type": "{{low_se_type_under}}", "language_name": "English", "location_name": "United States", "tag": "tag1", "device": "desktop", "os": "windows" }, "result": [ { "keyword": null, "type": "organic", "se_domain": "google.com", "location_code": 2840, "language_code": "en", "datetime": "2020-01-30 14:13:54 +0000", "items_count": 1, "items": [ { "page": 1, "date": "2020-01-30 14:13:54 +0000", "html": "<!doctype html><html><head></head></body></html>" } ] } ] } ] }
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, each Live SERP API call can contain only one task.
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 |
---|---|---|
location_name |
string | full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom |
location_code |
integer | search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations example: 2840 |
language_name |
string | full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages example: English |
language_code |
string | search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages example: en |
device |
string | device type optional field possible value: desktop |
os |
string | device operating system optional field possible values: windows |
market_type |
string | type of google finance market optional field possible values: most-active , indexes , indexes/americas , indexes/europe-middle-east-africa , indexes/asia-pacific , gainers , losers , climate-leaders , cryptocurrencies , currencies default value: most-active
|
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 object 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 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 keyword is returned with decoded %## (plus character ‘+’ 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 |
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 |
items_count |
integer | the number of results returned in the items array |
items |
array | elements of search results found in SERP |
page |
integer | serial number of the returned HTML page |
date |
string | date and time when the HTML page was scanned in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes” example: 2019-11-15 12:57:46 +00:00 |
html |
string | HTML page |