Skip to main content
GET
/
v1
/
local
/
descriptions
Error
A valid request URL is required to generate request examples
{
  "type": "local_descriptions",
  "results": [
    {
      "id": "<string>",
      "type": "local_description",
      "description": "<string>"
    }
  ]
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Headers

​
x-subscription-token
string
required

The subscription token that was generated for the product.

Example:

"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"

​
api-version
string | null

The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available.

​
accept
enum<string>
default:application/json

The default supported media type is application/json.

Available options:
application/json,
*/*
Example:

"application/json"

​
cache-control
enum<string> | null

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.

Available options:
no-cache
Allowed value: "no-cache"
​
user-agent
string | null

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.

Example:

"**Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"

Query Parameters

​
ids
string[]
required

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

Required array length: 1 - 20 elements

Response

Successful Response

​
type
enum<string>
default:local_descriptions
Available options:
local_descriptions
Allowed value: "local_descriptions"
​
results
(LocationDescription · object | null)[] | null

The list of location descriptions for the given location identifiers.