Skip to main content
GET
/
v1
/
suggest
/
search
{
  "type": "suggest",
  "query": {
    "original": "<string>",
    "show_strict_warning": true,
    "altered": "<string>",
    "cleaned": "<string>",
    "safesearch": true,
    "is_navigational": true,
    "is_geolocal": true,
    "local_decision": "<string>",
    "local_locations_idx": 123,
    "is_trending": true,
    "is_news_breaking": true,
    "ask_for_location": true,
    "language": {
      "main": "<string>"
    },
    "spellcheck_off": true,
    "country": "<string>",
    "bad_results": true,
    "should_fallback": true,
    "lat": "<string>",
    "long": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "header_country": "<string>",
    "more_results_available": true,
    "state": "<string>",
    "custom_location_label": "<string>",
    "reddit_cluster": "<string>",
    "summary_key": "<string>",
    "search_operators": {
      "applied": false,
      "cleaned_query": "<string>",
      "sites": [
        "<string>"
      ]
    }
  },
  "results": []
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Headers

​
x-subscription-token
string
required

The subscription token that was generated for the product.

Examples:

"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"

​
api-version
string | null

The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available.

​
accept
enum<string>

The default supported media type is application/json.

Available options:
application/json,
*/*
​
cache-control
enum<string> | null

Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.

Available options:
TitleConst
CacheControlno-cache
​
user-agent
string | null

The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.

Examples:

"**Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"

"**iOS** Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1"

"**macOS** Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"

"**Windows** Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"

Query Parameters

​
q
string
required

The user's suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50.

Required string length: 1 - 400
​
lang
enum<string>

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.

Available options:
ar,
eu,
bn,
bg,
ca,
zh-hans,
zh-hant,
hr,
cs,
da,
nl,
en,
en-gb,
et,
fi,
fr,
gl,
de,
el,
gu,
he,
hi,
hu,
is,
it,
jp,
kn,
ko,
lv,
lt,
ms,
ml,
mr,
nb,
pl,
pt-br,
pt-pt,
pa,
ro,
ru,
sr,
sk,
sl,
es,
sv,
ta,
te,
th,
tr,
uk,
vi
​
country
enum<string>

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.

Available options:
AR,
AU,
AT,
BE,
BR,
CA,
CL,
DK,
FI,
FR,
DE,
GR,
HK,
IN,
ID,
IT,
JP,
KR,
MY,
MX,
NL,
NZ,
NO,
CN,
PL,
PT,
PH,
RU,
SA,
ZA,
ES,
SE,
CH,
TW,
TR,
GB,
US,
ALL
​
count
integer
default:5

The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.

Required range: 1 <= x <= 20
​
rich
boolean
default:false

Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.

Response

Successful Response

​
query
object
required

Suggest search query string. Only the original query is returned.

​
type
enum<string>
default:suggest
Available options:
TitleConst
Typesuggest
​
results
SuggestResult · object[]

The list of suggestions for the given query.

⌘I