Brave Search

Brave Web Search API

Query Parameters

# Web Search API

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

Parameter	Required	Type	Default	Description
q	yes	string	none	The user's search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.
country	no	string	us	The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries. For a list of supported values, see Country Codes.
search_lang	no	string	en	The search language preference. The 2 or more character language code for which the search results are provided. For a list of possible values, see Language Codes.
ui_lang	no	string	en-US	User interface language preferred in response. Usually of the format `<language_code>-<country_code>`, see RFC 9110. For a list of supported values, see UI Language Codes.
count	no	int	20	The number of search results returned in response. The maximum is `20`. The actual number delivered may be less than requested. Combine this parameter with `offset` to paginate search results.
offset	no	int	0	The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is `9`. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with `count`. For example, if your user interface displays 20 search results per page, set `count` to `20` and `offset` to `0` to show the first page of results. To get subsequent pages, increment `offset` by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.
safesearch	no	string	moderate	Filters search results for adult content. The following values are supported: off Adult content is included where relevant. moderate Adult text but no adult images or videos. strict No adult content with adult text, images, and videos.
freshness	no	string	none	Filters search results by when they were discovered. The following time deltas are supported: pd Discovered within the last 24 hours. pw Discovered within the last 7 Days. pm Discovered within the last 31 Days. py Discovered within the last 365 Days. YYYY-MM-DDtoYYYY-MM-DD A timeframe is also supported by specifying the date range e.g. `2022-04-01to2022-07-30`.
text_decorations	no	bool	1	Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).
spellcheck	no	bool	1	Whether to spellcheck provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in `altered` key from the query response model.
result_filter	no	string	none	A comma delimited string of result types to include in the search response. Not specifying this parameter will return back all result types in search response where data is available and a plan with the corresponding option is subscribed. The response always includes `query` and `type` to identify any query modifications and response type respectively. Available result filter values are: discussions faq infobox news query summarizer videos web Example result filter value of `discussions,videos` returns only `query`, `discussions`, and `videos` responses.
goggles_id	no	string	none	Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository
units	no	string	none	The measurement units. If not provided, units are derived from search country. Possible values are: metric The standardized measurement system. imperial The British Imperial system of units.
extra_snippets	no	bool	none	A snippet is an excerpt from a page you get as a result of the query, and `extra_snippets` allow you to get up to 5 additional, alternative excerpts. Only available under `Free AI`, `Base AI`, `Pro AI`, `Base Data`, `Pro Data` and `Custom` plans.
summary	no	bool	none	This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.

Note

You can also optimise your search query by using search operators.

# Local Search API

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

Parameter	Required	Type	Default	Description
ids	yes	list[string]	none	Unique identifier for the location. Ids can not be empty. Maximum of 20 ids per request. The parameter can be repeated to query for multiple ids.
search_lang	no	string	en	The search language preference. The 2 or more character language code for which the location search results are provided. For a list of possible values, see Language Codes.
ui_lang	no	string	en-US	User interface language preferred in response. Usually of the format `<language_code>-<country_code>`, see RFC 9110. For a list of supported values, see UI Language Codes.
units	no	string	none	The measurement units. If not provided, units are derived from search country. Possible values are: metric The standardized measurement system. imperial The British Imperial system of units.