Brave Search

web

Gets the rich realtime result for the requested resource, ie. query like weather in london.

The rich result callback_key is obtained by performing first a Web Search and including the enable_rich_callback=true parameter in the request.

Requires a Search subscription.

Authorization

x-subscription-token string header required

The subscription token that was generated for the product.

Query Parameters

callback_key string required

The callback key to use for the rich header

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 "rich"

results object[]

response_callback_info object nullable

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/web/rich?callback_key=1234567890" \
  -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/web/rich"

params = {
    "callback_key": "1234567890"
}

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

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