Playground

This is a playground for the Search API. It allows you to test the API before you use it in your application.

Resource

Query Parameters

country

The 2 character country code where the search results come from. The default value is US.

search_lang

The 2 or more character language code for which the search results are provided. This is optional and defaults to en.

ui_lang

User interface language preferred in response. Usually of the format <language_code>-<country_code> See RFC 9110.

count

The number of search results returned in response. The default is 20 and the maximum is 20. The actual number delivered may be less than requested.
Combine this parameter with offset to page search results.

offset

The zero based offset that indicates number of search result pages (count) to skip before returning the result. The default is 0 and the maximum is 9. The actual number delivered may be less than requested.
Use this parameter along with the count parameter to page results. For example, if your user interface displays 10 search results per page, set count to 10 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 1 (for example, 0, 1, 2). It is possible for multiple pages to include some overlap in results.

safesearch

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.

The default value is moderate

spellcheck

A Boolean value that determines whether the spell checker should be enabled. The default is True.

freshness

Filters search results, when they were discovered, by date range. The following time deltas are supported.

Day - pd - Discovered in last 24 hours.
Week - pw - Discovered in last 7 Days.
Month - pm - Discovered in last 31 Days.
Year - py - Discovered in last 365 Days.

A timeframe is also supported by specifying the date range in the format YYYY-MM-DDtoYYYY-MM-DD.

text_decorations

A Boolean value that determines whether display strings should contain decoration markers such as hit highlighting characters. If true, the strings may include markers. The default is True.

result_filter

A comma delimited list of result types to include in the search response. Not specifying this parameter will return back all result types in search response based on plan.

units

Measurement units. If not provided, are derived from search country.

goggles

The goggle url or definition to rerank search results.

extra_snippets

Extra snippets in web search results.

summary

Enable summary for query

enable_rich_callback

Enable rich callback

Header Parameters

Prefilled options

x-loc-lat

Optional request header.

The latitude of the client's geographical location in degrees, to provide relevant local results. The latitiude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.

x-loc-long

Optional request header.

The longitude of the client's geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.

x-loc-timezone

Optional request header.

The IANA timezone for the client's device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database

x-loc-city

Optional request header.

The generic name of the client city

x-loc-state

Optional request header.

A code which could be up to three characters, that represent the client's state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.

x-loc-state-name

Optional request header.

The name of the client's state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.

x-loc-country

The two letter country code for the client's country. For a list of country codes, see ISO 3166-1 alpha-2

x-loc-postal-code

Optional request header.

The client's postal code

get

https://api.search.brave.com/res/v1/web/search

curl -s --compressed "https://api.search.brave.com/res/v1/web/search" \
     -H "Accept: application/json" \
     -H "Accept-Encoding: gzip"