Skip to main content
POST
Get autocomplete suggestions

Description

This endpoint provides Google autocomplete suggestions based on a query.

Endpoint

Headers

  • Content-Type: application/json
  • Authorization: Bearer <API_KEY> (required)

Request Body

Responses

Success (200)

Returns the autocomplete suggestions for the provided query.
  • Content-Type: application/json
  • X-RateLimit-Limit: The rate limit for the user.
  • X-RateLimit-Remaining: The remaining number of requests for the user.

Bad Request (400)

Returned if the request is invalid.

Unauthorized (401)

Returned if the API key is invalid or missing.

Internal Server Error (500)

Returned if there’s an error during the autocomplete process.

Example Request

Notes

  • The location, country, and language fields are optional and can be used to refine the suggestions based on geographic and linguistic context.
  • You can find a list of supported locations at GET: /api/v1/google-locations
  • Credit usage:
    • Each autocomplete request consumes 30 credits.

Rate Limiting

Rate limit headers (X-RateLimit-Limit and X-RateLimit-Remaining) are included in the response to indicate the user’s current rate limit status.

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required

Search phrase to autocomplete.

location
string

Free-form location context used by the upstream provider.

country
string

2-letter country code forwarded to the provider as gl.

language
string

Language code forwarded to the provider as hl.

requestSource
enum<string>

Optional identifier describing where the API request originated.

Available options:
API,
WEB,
MAKE_DOT_COM,
ZAPIER,
N8N,
PLAYGROUND,
DEFAULT_AUTOMATION,
AGENT_PREVIEW,
AGENT_LIVE,
AUTOPILOT,
STUDIO

Response

Autocomplete suggestions returned.

searchParameters
object
required
suggestions
object[]
required