> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# DataForSEO: Serp Google Autocomplete Live Advanced

> Google Autocomplete suggestions for a keyword, by location and language. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Google Autocomplete suggestions for a keyword, by location and language.

> [!NOTE]
>
> Tool ID: `dataforseo_serp_google_autocomplete_live_advanced`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_serp_google_autocomplete_live_advanced',
  {
    "keyword": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute dataforseo_serp_google_autocomplete_live_advanced --input '{
  "keyword": "software companies hiring engineers"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}
```

Use `deepline describe dataforseo_serp_google_autocomplete_live_advanced --json` for the latest machine-readable contract.

## Input reference

Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.keyword` | `string` | Yes | — | 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 |
| `payload.location_code` | `integer` | No | — | 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](https://api.dataforseo.com/v3/serp/google/locations) example: 2840 |
| `payload.language_code` | `string` | No | — | 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](https://api.dataforseo.com/v3/serp/google/languages) example: en |
| `payload.cursor_pointer` | `integer` | No | — | 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 |
| `payload.location_name` | `string` | No | — | 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](https://api.dataforseo.com/v3/serp/google/autocomplete/locations) example: London,England,United Kingdom |
| `payload.language_name` | `string` | No | — | 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](https://api.dataforseo.com/v3/serp/google/languages) example: English |
| `payload.client` | `string` | No | — | 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 See the live schema for the complete constraint. |
| `payload.tag` | `string` | No | — | 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 |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.",
    "properties": {
      "keyword": {
        "type": "string",
        "description": "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": {
        "type": "integer",
        "description": "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": {
        "type": "string",
        "description": "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": {
        "type": "integer",
        "description": "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"
      },
      "location_name": {
        "type": "string",
        "description": "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": {
        "type": "string",
        "description": "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"
      },
      "client": {
        "type": "string",
        "description": "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"
      },
      "tag": {
        "type": "string",
        "description": "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"
      }
    },
    "required": [
      "keyword"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Top-level response envelope for dataforseo\_serp\_google\_autocomplete\_live\_advanced.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.version` | `string` | Yes | — | the current version of the API |
| `result.status_code` | `integer` | Yes | — | 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 |
| `result.status_message` | `string` | Yes | — | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | — | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | — | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | — | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | — | array of tasks |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Top-level response envelope for dataforseo_serp_google_autocomplete_live_advanced.",
    "properties": {
      "version": {
        "type": "string",
        "description": "the current version of the API"
      },
      "status_code": {
        "type": "integer",
        "description": "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": {
        "type": "string",
        "description": "general informational message you can find the full list of general informational messages here"
      },
      "time": {
        "type": "string",
        "description": "execution time, seconds"
      },
      "tasks_count": {
        "type": "integer",
        "description": "the number of tasks in the tasks array"
      },
      "tasks_error": {
        "type": "integer",
        "description": "the number of tasks in the tasks array returned with an error"
      },
      "tasks": {
        "type": "array",
        "description": "array of tasks",
        "items": {}
      }
    },
    "required": [
      "version",
      "status_code",
      "status_message",
      "time",
      "tasks_count",
      "tasks_error",
      "tasks"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.03` per pricing unit.

## Related documentation

* [DataForSEO provider guide](https://deepline.com/docs/providers/dataforseo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.