serp/google/autocomplete/task_get/advanced

Get Google Autocomplete Advanced Results by id

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access

            
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access 
login="login" 
password="password" 
cred="$(printf ${login}:${password} | base64)" 
id="02261816-2027-0066-0000-c27d02864073" 
curl --location --request GET "https://api.dataforseo.com/v3/serp/google/autocomplete/task_get/advanced/${id}" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json" 
--data-raw ""


<?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();
}
try {
	$result = array();
	// #1 - using this method you can get a list of completed tasks
	// GET /v3/serp/google/autocomplete/tasks_ready
	// the full list of possible parameters is available in documentation
	$tasks_ready = $client->get('/v3/serp/google/autocomplete/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/google/autocomplete/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/google/autocomplete/task_get/advanced/$id
					/*
					if (isset($task_ready['id'])) {
						$result[] = $client->get('/v3/serp/google/autocomplete/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;
?>

            
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
# 1 - using this method you can get a list of completed tasks
# GET /v3/serp/google/autocomplete/tasks_ready
# the full list of possible parameters is available in documentation
response = client.get("/v3/serp/google/autocomplete/tasks_ready")
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response['status_code'] == 20000:
    results = []
    for task in response['tasks']:
        if (task['result'] and (len(task['result']) > 0)):
            for resultTaskInfo in task['result']:
                # 2 - using this method you can get results of each completed task
                # GET /v3/serp/google/autocomplete/advanced/$id
                if(resultTaskInfo['endpoint_advanced']):
                    results.append(client.get(resultTaskInfo['endpoint_advanced']))                
                '''
                # 3 - another way to get the task results by id
                # GET /v3/serp/google/autocomplete/task_get/advanced/$id                
                if(resultTaskInfo['id']):
                    results.append(client.get("/v3/serp/google/autocomplete/task_get/advanced/" + resultTaskInfo['id']))
                '''
    print(results)
    # do something with result
else:
    print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))

            
const task_id = '02231256-2604-0066-2000-57133b8fc54e';

const axios = require('axios');

axios({
    method: 'get',
    url: 'https://api.dataforseo.com/v3/serp/google/autocomplete/task_get/advanced/' + task_id,
    auth: {
        username: 'login',
        password: 'password'
    },
    headers: {
        'content-type': 'application/json'
    }
}).then(function (response) {
    var result = response['data']['tasks'];
    // Result data
    console.log(result);
}).catch(function (error) {
    console.log(error);
});

            
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

namespace DataForSeoDemos
{
    public static partial class Demos
    {
        public static async Task serp_task_get()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.dataforseo.com/"),
                // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
            };
            // #1 - using this method you can get a list of completed tasks
            // GET /v3/serp/google/autocomplete/tasks_ready
            // the full list of possible parameters is available in documentation
            var response = await httpClient.GetAsync("/v3/serp/google/autocomplete/tasks_ready");
            var tasksInfo = JsonConvert.DeserializeObject<dynamic>(await response.Content.ReadAsStringAsync());
            var tasksResponses = new List<object>();
            // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
            if (tasksInfo.status_code == 20000)
            {
                if (tasksInfo.tasks != null)
                {
                    foreach (var tasks in tasksInfo.tasks)
                    {
                        if (tasks.result != null)
                        {
                            foreach (var task in tasks.result)
                            {
                                if (task.endpoint_advanced != null)
                                {
                                    // #2 - using this method you can get results of each completed task
                                    // GET /v3/serp/google/autocomplete/task_get/advanced/$id
                                    var taskGetResponse = await httpClient.GetAsync((string)task.endpoint_advanced);
                                    var taskResultObj = JsonConvert.DeserializeObject<dynamic>(await taskGetResponse.Content.ReadAsStringAsync());
                                    if (taskResultObj.tasks != null)
                                    {
                                        var fst = taskResultObj.tasks.First;
                                        // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
                                        if (fst.status_code >= 40000 || fst.result == null)
                                            Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
                                        else
                                            tasksResponses.Add(fst.result);
                                    }
                                    // #3 - another way to get the task results by id
                                    // GET /v3/serp/google/autocomplete/task_get/advanced/$id
                                    /*
                                    var tasksGetResponse = await httpClient.GetAsync("/v3/serp/google/autocomplete/task_get/advanced/" + (string)task.id);
                                    var tasksResultObj = JsonConvert.DeserializeObject<dynamic>(await tasksGetResponse.Content.ReadAsStringAsync());
                                    if (tasksResultObj.tasks != null)
                                    {
                                        var fst = taskResultObj.tasks.First;
                                        // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
                                        if (fst.status_code >= 40000 || fst.result == null)
                                            Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
                                        else
                                            tasksResponses.Add(fst.result);
                                    }
                                    */
                                }
                            }
                        }
                    }
                }
                if (tasksResponses.Count > 0)
                    // do something with result
                    Console.WriteLine(String.Join(Environment.NewLine, tasksResponses));
                else
                    Console.WriteLine("No completed tasks");
            }
            else
                Console.WriteLine($"error. Code: {tasksInfo.status_code} Message: {tasksInfo.status_message}");
        }
    }
}

The above command returns JSON structured like this:

{
  "version": "0.1.20240514",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.0724 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "05302214-1535-0066-0000-c08961d3de14",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0187 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "serp",
        "google",
        "autocomplete",
        "task_get",
        "advanced",
        "05302214-1535-0066-0000-c08961d3de14"
      ],
      "data": {
        "se_type": "autocomplete",
        "se": "google",
        "api": "serp",
        "function": "task_get",
        "language_code": "en",
        "location_code": 2840,
        "keyword": "albert einstein",
        "client": "gws-wiz-serp",
        "device": "desktop",
        "os": "windows"
      },
      "result": [
        {
          "keyword": "albert einstein",
          "type": "autocomplete",
          "se_domain": "google.com",
          "location_code": 2840,
          "language_code": "en",
          "check_url": "https://google.com/search?q=albert+einstein&hl=en&gl=US&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc",
          "datetime": "2024-05-30 19:14:51 +00:00",
          "spell": null,
          "refinement_chips": null,
          "item_types": [
            "autocomplete"
          ],
          "se_results_count": 0,
          "items_count": 10,
          "items": [
            {
              "type": "autocomplete",
              "rank_group": 1,
              "rank_absolute": 1,
              "relevance": null,
              "suggestion": "albert einstein",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein",
              "thumbnail_url": "http://t0.gstatic.com/images?q=tbn:ANd9GcSFn2iZxs3MN8ja-4Gx7maVbATd52RTpRCrJ-WljxMFWeszvflAZjtziuiRdQ&s=10",
              "highlighted": null
            },
            {
              "type": "autocomplete",
              "rank_group": 2,
              "rank_absolute": 2,
              "relevance": null,
              "suggestion": "albert einstein college of medicine",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+college+of+medicine",
              "thumbnail_url": "http://t0.gstatic.com/images?q=tbn:ANd9GcSa9iqJoNmJhras1iH1oiUx2UMCZVM_5VFmPjJXvE-K&s=10",
              "highlighted": null
            },
            {
              "type": "autocomplete",
              "rank_group": 3,
              "rank_absolute": 3,
              "relevance": null,
              "suggestion": "albert einstein iq",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+iq",
              "thumbnail_url": null,
              "highlighted": [
                "iq"
              ]
            },
            {
              "type": "autocomplete",
              "rank_group": 4,
              "rank_absolute": 4,
              "relevance": null,
              "suggestion": "albert einstein death",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+death",
              "thumbnail_url": null,
              "highlighted": [
                "death"
              ]
            },
            {
              "type": "autocomplete",
              "rank_group": 5,
              "rank_absolute": 5,
              "relevance": null,
              "suggestion": "albert einstein quotes",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+quotes",
              "thumbnail_url": "http://t0.gstatic.com/images?q=tbn:ANd9GcRnmMaYbKfIi4s248o1yaRqUZUCsaoJxjiS4BA_s2d8h-WKhBkVbPU98CW-Xw&s=10",
              "highlighted": null
            },
            {
              "type": "autocomplete",
              "rank_group": 6,
              "rank_absolute": 6,
              "relevance": null,
              "suggestion": "albert einstein news",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+news",
              "thumbnail_url": null,
              "highlighted": [
                "news"
              ]
            },
            {
              "type": "autocomplete",
              "rank_group": 7,
              "rank_absolute": 7,
              "relevance": null,
              "suggestion": "albert einstein wife",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+wife",
              "thumbnail_url": null,
              "highlighted": [
                "wife"
              ]
            },
            {
              "type": "autocomplete",
              "rank_group": 8,
              "rank_absolute": 8,
              "relevance": null,
              "suggestion": "albert einstein brain",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+brain",
              "thumbnail_url": null,
              "highlighted": [
                "brain"
              ]
            },
            {
              "type": "autocomplete",
              "rank_group": 9,
              "rank_absolute": 9,
              "relevance": null,
              "suggestion": "albert einstein inventions",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+inventions",
              "thumbnail_url": null,
              "highlighted": [
                "inventions"
              ]
            },
            {
              "type": "autocomplete",
              "rank_group": 10,
              "rank_absolute": 10,
              "relevance": null,
              "suggestion": "albert einstein hospital",
              "suggestion_type": null,
              "search_query_url": "https://www.google.com/search?q=albert+einstein+hospital",
              "thumbnail_url": null,
              "highlighted": [
                "hospital"
              ]
            }
          ]
        }
      ]
    }
  ]
}

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 and possible extra elements by making a request to the following Sandbox URL:
https://sandbox.dataforseo.com/v3/serp/google/autocomplete/task_get/advanced/00000000-0000-0000-0000-000000000000
The response will include all available items in the Google Autocomplete SERP Advanced 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 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; in this case, will equal `null`
`refinement_chips`	object	search refinement chips
`type`	string	type of element = ‘refinement_chips’
`xpath`	string	the XPath of the element
`items`	array	items of the element
`type`	string	type of element = ‘refinement_chips_element’
`title`	string	title of the element
`url`	string	search URL with refinement parameters
`domain`	string	domain in SERP
`options`	array	further search refinement options
`type`	string	type of element = ‘refinement_chips_option’
`title`	string	title of the element
`url`	string	search URL with refinement parameters
`domain`	string	domain in SERP
`item_types`	array	types of search results in SERP contains types of search results (`items`) found in SERP. possible item types: `autocomplete`
`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
`type`	string	type of element = ‘autocomplete’
`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
`relevance`	integer	relevance of suggested keyword represents the relevant of the autocomplete suggestion to the target keyword can take values from `500` to `2000` the higher the value, the more relevant is the suggestion Note: only available for the following `client`: `chrome/chrome-omni`
`suggestion`	string	google autocomplete keyword suggestion
`suggestion_type`	string	google autocomplete suggestion type Note: only available for the following `client`: `chrome/chrome-omni`
`search_query_url`	string	url to search results url to search results relevant to the google autocomplete suggestion
`thumbnail_url`	string	url of the thumbnail image url of the thumbnail image of the google autocomplete suggestion Note: only available for the following `client`: `gws-wiz` `gws-wiz-serp`
`highlighted`	array	keywords highlighted in autocomplete contains a list of google autocomplete suggestions that are highlighted in the search bar; Note: array is only available for the following `client`: `gws-wiz` `psy-ab` `gws-wiz-local`

‌‌