Piloterr

Google Search Autocomplete

GET
/v2/google/search/autocomplete

Retrieve real-time Google Search autocomplete suggestions for any query, with support for language and country localization.

Credit cost: 1 credit per call

Autorización

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parámetros de consulta

query*string

The partial or complete search query for which you want to retrieve autocomplete suggestions from Google.

Example:

coffee
cp?number

Cursor position in the query string where autocomplete suggestions should be generated. Determines which part of the query is being completed.

  • 0: Suggestions based on the full query (default)
  • 5: Suggestions based on the first 5 characters of the query
Default"0"
google_domain?string

Google domain to use for the search. Defaults to google.com.

Examples:

  • google.com
  • google.co.uk
  • google.fr

Example:

google.com
Default"google.com"
gl?string

Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France).

Example:

us
Default"us"
hl?string

Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419).

Example:

en
Default"en"
cr?string

Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).

Example:

countryUS
lr?string

Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).

Example:

lang_en
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Cuerpo de la respuesta

Successful response

application/json
  1. response
suggestions?array<>
search_parameters?
Example Request
curl -X GET 'https://api.piloterr.com/v2/google/search/autocomplete?query=string'
Example Response
{  "suggestions": [    {      "value": "ryze mushroom coffee"    },    {      "value": "coffee near me"    },    {      "value": "mushroom coffee"    },    {      "value": "keurig coffee maker"    },    {      "value": "costa coffee"    },    {      "value": "zus coffee"    },    {      "value": "ninja coffee machine"    },    {      "value": "black rifle coffee"    },    {      "value": "delonghi coffee machine"    },    {      "value": "coffee shops near me"    }  ],  "search_parameters": {    "q": "coffee",    "cp": 0,    "gl": "us",    "hl": "en",    "engine": "google",    "google_domain": "google.com"  }}