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/naver/organic/tasks_ready // in addition to 'naver' and 'organic' 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/naver/organic/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/naver/organic/task_get/regular/$id if (isset($task_ready['endpoint_regular'])) { $result[] = $client->get($task_ready['endpoint_regular']); } // #3 - another way to get the task results by id // GET /v3/serp/naver/organic/task_get/regular/$id /* if (isset($task_ready['id'])) { $result[] = $client->get('/v3/serp/naver/organic/task_get/regular/' . $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.20210304", "status_code": 20000, "status_message": "Ok.", "time": "0.2318 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "03171324-1535-0066-0000-770617fdc9a8", "status_code": 20000, "status_message": "Ok.", "time": "0.1293 sec.", "cost": 0, "result_count": 1, "path": [ "v3", "serp", "naver", "organic", "task_get", "regular", "03171324-1535-0066-0000-770617fdc9a8" ], "data": { "api": "serp", "function": "task_get", "se": "naver", "se_type": "organic", "keyword": "iphone", "priority": 2, "tag": "some_string_123", "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", "device": "desktop", "os": "windows" }, "result": [ { "keyword": "iphone", "type": "organic", "se_domain": "search.naver.com", "location_code": 0, "language_code": "", "check_url": "https://search.naver.com/search.naver?display=15&start=1&page=1&where=nexearch&sm=tab_hty.top&query=iphone&", "datetime": "2021-03-17 11:24:44 +00:00", "spell": null, "refinement_chips": null, "item_types": [ "organic", "paid", "related_searches" ], "se_results_count": 0, "items_count": 110, "items": [ { "type": "organic", "rank_group": 1, "rank_absolute": 1, "domain": "www.apple.com", "title": "iPhone - Apple (KR)", "description": "세상에서 가장 강력한 개인용 기기, iPhone 을 만나볼까요? iPhone 12 Pro, iPhone 12 Pro Max, iPhone 12, iPhone 12 mini, iPhone SE를 지금 살펴보세요.", "url": "https://www.apple.com/kr/iphone/", "breadcrumb": "www.apple.com/kr/iphone" }, { "type": "paid", "rank_group": 1, "rank_absolute": 2, "domain": "adcr.naver.com", "title": "IPHONE LG헬로모바일", "description": "0원부터 만나는 아이폰 시리즈, 중고폰+알뜰요금제 조합으로 통신비 절약", "url": "https://adcr.naver.com/adcr?x=TXP4bCFiwDoPWdTqAdXnF////w==kE1WdFcyC+QcsUgeSJZDncZo2LIfkktrQKKZAM8cjOLF2/rN+AQgGr6mp1Vx+9n4OMvWQ/ELrq19BvrhYBZjc0Fm6KhyC9xpp9sKXFm4GuqD4a5y62gElCN610iUpguLIUJpZnDNodHBcViC6VQx8+WCQBhfmuLDKd810sMjQHn7uEuIBsC19baezvGr0us7NoHRC36EX8548F6eefEoEB45OgmhdkqlUeWNPTTJLWIRHTUs54dfBw5S3l/EUFfwM8M0xR3GARcKcxXpBtlMIzNTAO1N8C7XhCe7drYoFdKaqdLGhy/CcU0gVKuYYBHFSOOId56TsbShnLGB9qdDbI4XL8KhKfoB4Fo4T/wO8+k0ol25fADgU4mUZKqjJ0VKb2Ii2b7Dq4JfNXXLkTSBjbFdpngkJInMdiLGBn/3Pcj50/zCVBZS/AwNduD60/n4+ppgasOOzjtrsn4TSUqRQ3B9RZn1sWOCRVzmn4P74p7bTf3U44ncGJnthoe9ws+2H0efYS/MdA8bgAnUAEUwwRuqCYtW59oKaAQtDwHkhT9oViYr+/xiGR35C1w1LPJzPDpcgz4CLcjPGyM5BfAyZvKH5LLjPkFJCTyZTx+bkv9BZmdo1QWdIpxa+LOKY59UUTraPdaWzKa9Xmln2C2HiHLoke1iWTHVavf5erHSkchXW+K5zBRAqe1xMDY7YWcfoDDLnU8NcfIZk3QqbX86aMOw5iR97WopjrLiIDCX5G+PuoyqynegwUxWrTTie62e1N1wfbVgze9nE/WPgHucvqPlBF/U3OVcx97x9+wK6WllgMN2k5XJQ64PcinzpSXJX0Q2t83w5jgPqzmWy/jf3WA==&p=0", "breadcrumb": "direct.lghellovision.net" } ] } ] } ] }
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.
You can also get all available SERP features by making a request to the following Sandbox URL:
https://sandbox.dataforseo.com/v3/serp/naver/organic/task_get/regular/00000000-0000-0000-0000-000000000000
The response will include all available items in the Naver Organic SERP Regular endpoint with the fields containing dummy data.
You won’t be charged for using Sandbox endpoints.
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 that were returned 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 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 , including_results_for |
refinement_chips |
object | search refinement chips equals null |
item_types |
array | types of search results found in SERP contains types of all search results ( items ) found in the returned SERPpossible item types: images , local_pack , map , organic , paid , related_searches , video
note that this array contains all types of search results found in the returned SERP; to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the Naver Organiс Advanced SERP endpoint |
se_results_count |
integer | total number of results in SERP |
items_count |
integer | the number of results returned in the items array |
items |
array | items in SERP |
‘organic’ element in SERP | ||
type |
string | type of element = ‘organic’ |
rank_group |
integer | group rank in SERP position within a group of elements with identical type valuespositions of elements with different type values are omitted from rank_group |
rank_absolute |
integer | absolute rank in SERP absolute position among all the elements found in SERP |
domain |
string | domain in SERP |
title |
string | title of the results element in SERP |
description |
string | description of the results element in SERP |
url |
string | relevant URL in SERP |
breadcrumb |
string | breadcrumb in SERP |
‘paid’ element in SERP | ||
type |
string | type of element = ‘paid’ |
rank_group |
integer | group rank in SERP position within a group of elements with identical type valuespositions of elements with different type values are omitted from rank_group |
rank_absolute |
integer | absolute rank in SERP absolute position among all the elements found in SERP |
domain |
string | domain in SERP |
title |
string | title of the results element in SERP |
description |
string | description of the results element in SERP |
url |
string | relevant URL in SERP |
breadcrumb |
string | breadcrumb in SERP |