Setting Google Autocomplete Tasks

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein",
    "cursor_pointer": 6
  }
]'

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein",
    "cursor_pointer": 6
  }
]
'

import requests

url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post"

payload = [
    {
        "language_code": "en",
        "location_code": 2840,
        "keyword": "albert einstein",
        "cursor_pointer": 6
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      language_code: 'en',
      location_code: 2840,
      keyword: 'albert einstein',
      cursor_pointer: 6
    }
  ])
};

fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'language_code' => 'en',
        'location_code' => 2840,
        'keyword' => 'albert einstein',
        'cursor_pointer' => 6
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post"

	payload := strings.NewReader("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\",\n    \"cursor_pointer\": 6\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\",\n    \"cursor_pointer\": 6\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\",\n    \"cursor_pointer\": 6\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {
      "id": "<string>",
      "status_code": 123,
      "status_message": "<string>",
      "time": "<string>",
      "cost": 123,
      "result_count": 123,
      "path": [
        "<string>"
      ],
      "data": {},
      "result": {}
    }
  ]
}

POST

https://api.aisa.one

apis

dataforseo

serp

google

autocomplete

task_post

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein",
    "cursor_pointer": 6
  }
]'

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein",
    "cursor_pointer": 6
  }
]
'

import requests

url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post"

payload = [
    {
        "language_code": "en",
        "location_code": 2840,
        "keyword": "albert einstein",
        "cursor_pointer": 6
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      language_code: 'en',
      location_code: 2840,
      keyword: 'albert einstein',
      cursor_pointer: 6
    }
  ])
};

fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'language_code' => 'en',
        'location_code' => 2840,
        'keyword' => 'albert einstein',
        'cursor_pointer' => 6
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post"

	payload := strings.NewReader("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\",\n    \"cursor_pointer\": 6\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\",\n    \"cursor_pointer\": 6\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"language_code\": \"en\",\n    \"location_code\": 2840,\n    \"keyword\": \"albert einstein\",\n    \"cursor_pointer\": 6\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {
      "id": "<string>",
      "status_code": 123,
      "status_message": "<string>",
      "time": "<string>",
      "cost": 123,
      "result_count": 123,
      "path": [
        "<string>"
      ],
      "data": {},
      "result": {}
    }
  ]
}

Queues the suggestions Google offers as a query is typed on Google, returning a task id in tasks[0].id. The charge lands here; fetching is free, including re-fetching. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The live twin answers immediately and is simpler for a single query; queue when the batch would outlast a tool call.

Example

curl -X POST "https://api.aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[{"keyword": "...", "client": "...", "location_name": "..."}]'

Cost and request rules

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Default request reference estimate (USD): 0.02
Cost contract: response_usd
Published reference multiplier: 1.0
Settlement evidence source: response_body

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

keyword

string

keyword

required field

you can specify up to 700 characters in the keyword field

all %## will be decoded (plus character ‘+’ will be decoded to a space character)

if you need to use the “%” character for your keyword, please specify it as “%25”;

if you need to use the “+” character for your keyword, please specify it as “%2B”;

learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

location_code

integer

search engine location code

required field if you don't 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_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

cursor_pointer

integer | null

search bar cursor pointer

optional field

the horizontal numerical position of the cursor pointer within the keyword in the search bar;

by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;

minimal value: 0

default value: the number of the last character of the specified keyword

example:

|which query are s - "cursor_pointer": 0

which query is s| - "cursor_pointer": 16

which que|ry is s - "cursor_pointer": 9

priority

integer | null

task priority

optional field

can take the following values:

1 – normal execution priority (set by default);

2 – high execution priority

You will be additionally charged for the tasks with high execution priority;

The cost can be calculated on the Pricing page

pingback_url

string | null

notification URL of a completed task

optional field

when a task is completed we will notify you by GET request sent to the URL you have specified

you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.

example:

http://your-server.com/pingscript?id=$id

http://your-server.com/pingscript?id=$id&tag=$tag

Note: special characters in pingback_url will be urlencoded;

i.a., the # character will be encoded into %23

learn more on our Help Center

postback_url

string | null

URL for sending task results

optional field

once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request

example:

http://your-server.com/postbackscript?id=$id

http://your-server.com/postbackscript?id=$id&tag=$tag

Note: special characters in postback_url will be url-encoded;

i.e., the # character will be encoded into %23

learn more on our Help Center

postback_data

string

postback_url datatype

required field if you specify postback_url

corresponds to the datatype that will be sent to your server

possible values:

advanced

client

string | null

search client for autocomplete

optional field

autocomplete results may differ depending on the search client;

possible values:

chrome — used when google search is opened in google chrome;

chrome-omni — used in the address bar in chrome;

gws-wiz — used in google search home page;

gws-wiz-serp — used in google search engine results page;

safari — used when google search is opened in safari browser;

firefox — used when google search is opened in firefox browser;

psy-ab — may be used when google search is opened in google chrome browser;

toolbar — returns XML;

youtube — returns JSONP;

gws-wiz-local — used in google local;

img — used in google's image search;

products-cc — used in google shopping search

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/autocomplete/locations

example:

London,England,United Kingdom

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 https://api.dataforseo.com/v3/serp/google/languages

example:

English

tag

string | null

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

Example:

[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein",
    "cursor_pointer": 6
  }
]

Response

object | null

Successful operation

version

string | null

the current version of the API

status_code

integer | null

general status code you can find the full list of the response codes here

status_message

string | null

general informational message you can find the full list of general informational messages here

time

string | null

total execution time, seconds

cost

number<double> | null

total tasks cost, USD

tasks_count

integer<int64> | null

the number of tasks in the tasks array

tasks_error

integer<int64> | null

the number of tasks in the tasks array returned with an error

tasks

(object | null)[] | null

array of tasks

Show child attributes

​Example

​Cost and request rules

Authorizations

Body

Response

Example

Cost and request rules