Brave Search

web

Authorization

x-subscription-token string header required

The subscription token that was generated for the product.

Query Parameters

ids string[] required

A list of unique identifiers for the location. The ids are valid only for 8 hours.

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

results object[] nullable

400 Bad Request

type string

error object required

time integer

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/local/descriptions?ids=loc4FNMQJNOOCVHEB7UBOLN354ZYIDIYJ3RPRETERRY%3D" \
  -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/local/descriptions"

params = {
    "ids": "loc4FNMQJNOOCVHEB7UBOLN354ZYIDIYJ3RPRETERRY="
}

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

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