Suggest API

Query Parameters

# Suggest Search API

This table lists the query parameters supported by the Suggest Search API. Some are required, but most are optional.

Parameter Required Type Default Description
q yes string none The user's suggest search query term. Query can not be empty. The max query length is 400 characters and word limit is 50.
country no string us

The suggest search query country, where potentially the results could come from.

The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses. For a list of supported supported values, see Country Codes.

lang no string en

The suggest search language preference, where potentially the results could come from.

The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses. For a list of possible values, see Language Codes.

count no int 5 The number of suggestions returned. This is done as best effort. The maximum is 20.
rich no bool 0 Whether to enhance suggestions with rich results. This is an extra option in plans which needs to be enabled.