Brave Search

other

Intelligent search suggestions to help users find what they’re looking for.

Authorization

x-subscription-token string header required

The subscription token that was generated for the product.

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.

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.

Default: "en"

Available options: areubn

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.

Default: "US"

Available options: ARAUAT

count integer

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.

Min: 1 Max: 20 Default: 5

rich boolean

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

Default: false

Headers

api-version string

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

accept enum<string>

The default supported media type is application/json.

Default: "application/json"

Available options: application/json*/*

cache-control "no-cache"

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.

user-agent string

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.

Responses

200 Successful Response

type "suggest"

query object required

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

results object[]

The list of suggestions for the given query.

404 Not Found

type string

error object required

time integer

422 Unprocessable Entity

type string

error object required

time integer

429 Too Many Requests

type string

error object required

time integer

curl "https://api.search.brave.com/res/v1/suggest/search?q=how+to+" \
  -H "Accept: application/json" \ 
  -H "Accept-Encoding: gzip" \ 
  -H "X-Subscription-Token: <YOUR_API_KEY>"

import requests

url = "https://api.search.brave.com/res/v1/suggest/search"

params = {
    "q": "how to "
}

headers = {
    "Accept": "application/json",
    "Accept-Encoding": "gzip",
    "X-Subscription-Token": "<YOUR_API_KEY>"
}

response = requests.get(url, params=params, headers=headers)
print(response.json())