Logo SearchApi

Google Autocomplete API

GET   /api/v1/search?engine=google_autocomplete
OpenAPI Initiative Download OpenAPI Spec

API Parameters

Search Query

  • Name
    q
    Required
    Required
    Description

    Search query that would produce autocomplete suggestions.

Filters

  • Name
    client
    Required
    Optional
    Description

    This parameter identifies the client initiating the autocomplete request. For instance, using chrome as the value signifies that the request comes from the Chrome browser. The API may customize the response in terms of format or content based on the identified client. Various other values can be set to represent different browsers or applications, each affecting the autocomplete results in a corresponding manner. Key client types supported by this API include:

    • chrome (default) - used for Chrome browser searches.
    • chrome-omni - used for Chrome address bar.
    • gws-wiz - used for Chrome Google homepage.
    • gws-wiz-local - used for searches on Google Local.
    • safari - used when Google is opened in Safari browser
    • firefox - used for Firefox browser searches.
    • psy-ab - used for Google search queries.
    • youtube - origin unknown. Returns JSONP.
    • toolbar - origin unknown. Returns XML.

  • Name
    cp
    Required
    Optional
    Description

    The cp parameter is used to determine the cursor position within the search query for autocomplete requests. A 0 value places the cursor at the start of the query (like |some query), whereas not including cp suggests the cursor is at the end of the query (like some query|). The location of the cursor is important as it affects the suggestions provided by the autocomplete feature of the API.

Localization

  • Name
    gl
    Required
    Optional
    Description

    The default parameter us defines the country of the search. Check the full list of supported Google gl countries.

  • Name
    hl
    Required
    Optional
    Description

    The default parameter en defines the interface language of the search. Check the full list of supported Google hl languages.

Engine

  • Name
    engine
    Required
    Required
    Description

    Parameter defines an engine that will be used to retrieve real-time data. It must be set to google_autocomplete.

API key

  • Name
    api_key
    Required
    Required
    Description

    The api_key authenticates your requests. Use it as a query parameter (https://www.searchapi.io/api/v1/search?api_key=YOUR_API_KEY) or in the Authorization header (Bearer YOUR_API_KEY).

Zero Data Retention

  • Name
    zero_retention
    Enterprise Only
    Enterprise Only
    Required
    Optional
    Description

    Set this parameter to true to disable all logging and persistent storage. No request parameters, HTML, or JSON responses are stored or logged. Suitable for high-compliance use cases. Debugging and support may be limited while enabled.

API Examples

Google Home Page Results

Google Home Page Results

Modifying client parameters impacts the results of completions. An example is provided for gws-wiz.

GET
https://www.searchapi.io/api/v1/search?client=gws-wiz&engine=google_autocomplete&q=ama
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "google_autocomplete",
  "q": "ama",
  "client": "gws-wiz"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "suggestions": [
    {
      "value": "amazon",
      "type": 46,
      "title": "Amazon",
      "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTPmIckKCzf8qUxF89dXVgIkQQOaAAVW9PwzBh_I9E&s=10"
    },
    { "value": "amazon prime" },
    { "value": "amazon prime video" },
    ...
  ]
}

Safari Results

Safari Results

Modifying client parameters impacts the results of completions. An example is provided for safari.

GET
https://www.searchapi.io/api/v1/search?client=safari&engine=google_autocomplete&q=Training
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "google_autocomplete",
  "q": "Training",
  "client": "safari"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "suggestions": [
    { "value": "training" },
    { "value": "training day" },
    ...
  ]
}

Chrome Address Bar Results

Chrome Address Bar Results

Modifying client parameters impacts the results of completions. An example is provided for chrome-omni.

GET
https://www.searchapi.io/api/v1/search?client=chrome-omni&engine=google_autocomplete&q=Cha
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "google_autocomplete",
  "q": "Cha",
  "client": "chrome-omni"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "suggestions": [
    {
      "value": "chatgpt",
      "relevance": 801,
      "type": "QUERY"
    },
    ...
  ],
  "verbatim_relevance": 851
}

Custom Cursor Pointer

Custom Cursor Pointer

Changing cp parameter impacts suggestions. Setting cp parameter to 1 will move the cursor pointer one position to the right.

GET
https://www.searchapi.io/api/v1/search?client=gws-wiz&cp=1&engine=google_autocomplete&q=K+Kardashian
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "google_autocomplete",
  "q": "K Kardashian",
  "client": "gws-wiz",
  "cp": "1"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "suggestions": [
    { "value": "kim kardashian" },
    { "value": "kourtney kardashian" },
    ...
  ]
}

Language & Location set to Spanish Results

Language & Location set to Spanish Results

Modifying gl & hl parameters impacts the results of completions. An example is provided for es.

GET
https://www.searchapi.io/api/v1/search?client=gws-wiz&engine=google_autocomplete&gl=es&hl=es&q=gpt-4
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "google_autocomplete",
  "q": "gpt-4",
  "client": "gws-wiz",
  "gl": "es",
  "hl": "es"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "suggestions": [
    { "value": "gpt-4 openai" },
    { "value": "gpt-4 gratis" },
    ...
  ]
}