Skip to main content
GET
Autocomplete
Get suggestions for a partial query. query is nonblank, up to 2,048 characters; country defaults to us and accepts the native locale codes. Credits: 2 per nonempty successful response. Confirmed empty suggestions and errors are unbilled. suggestions includes query, type, is_entity, and optional name, desc, img, category, and logo when Brave provides them. The response also includes result_count, source_url, and observation time as fetched_at/fetched_utc. Invalid or unsupported parameters return 422; a restricted key needs the brave scope.

Authorizations

X-API-Key
string
header
required

Query Parameters

query
string
required
Required string length: 1 - 2048
country
enum<string>
default:us
Available options:
us,
all,
ar,
au,
at,
be,
br,
ca,
cl,
cn,
dk,
fi,
fr,
de,
gr,
hk,
in,
id,
it,
jp,
kr,
my,
mx,
nl,
nz,
no,
ph,
pl,
pt,
ru,
sa,
sg,
za,
es,
se,
ch,
tw,
tr,
gb

Response

Successful Response

query
string
required
country
string
required
suggestions
BraveSuggestion · object[]
required
result_count
integer
required
source_url
string
required
fetched_at
string
required
fetched_utc
number
required