Authorizations
The subscription token that was generated for the product.
Headers
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.
-90 <= x <= 90The 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.
-180 <= x <= 180The IANA timezone for the client's device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database.
The generic name of the client city.
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.
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.
The two letter country code for the client's country. For a list of country codes, see ISO 3166-1 alpha-2.
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW The client's postal code.
The subscription token that was generated for the product.
"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"
The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available.
The default supported media type is application/json.
application/json, */* 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.
| Title | Const |
|---|---|
| CacheControl | no-cache |
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.
"**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
The user's search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.
1 - 400The 2 character country code where the search results come from. The default value is US.
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 The 2 or more character language code for which the search results are provided.
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 User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.
es-AR, en-AU, de-AT, nl-BE, fr-BE, pt-BR, en-CA, fr-CA, es-CL, da-DK, fi-FI, fr-FR, de-DE, el-GR, zh-HK, en-IN, en-ID, it-IT, ja-JP, ko-KR, en-MY, es-MX, nl-NL, en-NZ, no-NO, zh-CN, pl-PL, en-PH, ru-RU, en-ZA, es-ES, sv-SE, fr-CH, de-CH, zh-TW, tr-TR, en-GB, en-US, es-US 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.
NOTE: Count only applies to web results.
1 <= x <= 50The 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.
0 <= x <= 9Filters search results for adult content. The following values are supported:
- off - No filtering is done.
- moderate - Filters explicit content, like images and videos, but allows adult domains in the search results.
- strict - Drops all adult content from search results.
off, moderate, strict 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.
Filters search results by when they were discovered. The following values 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 - timeframe is also supported by specifying the date range e.g. 2022-04-01to2022-07-30.
Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).
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, locations.
NOTE: count only applies to web results.
The measurement units. Possible values are:
- metric - The standardized measurement system
- imperial - The British Imperial system of units
imperial, metric Goggles act as a custom re-ranking on top of Brave's search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.
Goggles act as a custom re-ranking on top of Brave's search index. The parameter supports both a url where the Goggle is hosted or the definition of the goggle. For more details, refer to the Goggles repository. The parameter can be repeated to query with multiple goggles.
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.
This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.
Enable rich callback
Include fetch metadata
Whether to apply search operators
Response
Successful Response
| Title | Const |
|---|---|
| Type | search |
Search query string and its modifications that are used for search.
Discussions clusters aggregated from forum posts that are relevant to the query.
Frequently asked questions that are relevant to the search query.
Aggregated information on an entity showable as an infobox.
Places of interest (POIs) relevant to location sensitive queries.
Preferred ranked order of search results.
News results relevant to the query.
Videos results relevant to the query.
Web results relevant to the query.
Summary key to get summary results for the query.
Callback information to retrieve rich results.