Skip to main content
GET
/
v1
/
local
/
pois
{
  "type": "local_pois",
  "results": [
    {
      "title": "<string>",
      "url": "<string>",
      "is_source_local": false,
      "is_source_both": false,
      "description": "<string>",
      "page_age": "<string>",
      "page_fetched": "<string>",
      "fetched_content_timestamp": 123,
      "profile": {
        "name": "<string>",
        "url": "<string>",
        "long_name": "<string>",
        "img": "<string>"
      },
      "language": "<string>",
      "family_friendly": true,
      "type": "location_result",
      "provider_url": "<string>",
      "coordinates": [
        "<any>"
      ],
      "zoom_level": 7,
      "thumbnail": {
        "src": "<string>",
        "alt": "<string>",
        "height": 123,
        "width": 123,
        "bg_color": "<string>",
        "original": "<string>",
        "logo": true,
        "duplicated": true,
        "theme": "<string>"
      },
      "postal_address": {
        "type": "PostalAddress",
        "country": "<string>",
        "postalCode": "<string>",
        "streetAddress": "<string>",
        "addressRegion": "<string>",
        "addressLocality": "<string>",
        "displayAddress": "<string>"
      },
      "opening_hours": {
        "current_day": [
          {
            "abbr_name": "<any>",
            "full_name": "<any>",
            "opens": "<any>",
            "closes": "<any>"
          }
        ],
        "days": [
          [
            {
              "abbr_name": "<any>",
              "full_name": "<any>",
              "opens": "<any>",
              "closes": "<any>"
            }
          ]
        ]
      },
      "contact": {
        "email": "<string>",
        "telephone": "<string>"
      },
      "price_range": "<string>",
      "rating": {
        "ratingValue": 1,
        "bestRating": 1,
        "reviewCount": 123,
        "profile": {},
        "is_tripadvisor": false
      },
      "distance": {
        "value": 123,
        "units": "<string>"
      },
      "profiles": [
        {
          "type": "external",
          "name": "<string>",
          "url": "<string>",
          "long_name": "<string>",
          "img": "<string>"
        }
      ],
      "reviews": {
        "results": [
          {
            "title": "<string>",
            "description": "<string>",
            "date": "<string>",
            "rating": {
              "ratingValue": 1,
              "bestRating": 1,
              "reviewCount": 123,
              "profile": {},
              "is_tripadvisor": true
            },
            "author": {
              "type": "person",
              "name": "<string>",
              "url": "<string>",
              "thumbnail": {},
              "email": "<string>"
            },
            "review_url": "<string>",
            "language": "<string>"
          }
        ],
        "viewMoreUrl": "<string>",
        "reviews_in_foreign_language": true
      },
      "pictures": {
        "viewMoreUrl": "<string>",
        "results": [
          {
            "src": "<string>",
            "alt": "<string>",
            "height": 123,
            "width": 123,
            "bg_color": "<string>",
            "original": "<string>",
            "logo": true,
            "duplicated": true,
            "theme": "<string>"
          }
        ]
      },
      "action": {
        "type": "<string>",
        "url": "<string>"
      },
      "serves_cuisine": [
        "<string>"
      ],
      "categories": [],
      "icon_category": "<string>",
      "timezone": "<string>",
      "timezone_offset": 123,
      "id": "<string>",
      "results": [
        {
          "title": "<string>",
          "url": "<string>",
          "is_source_local": false,
          "is_source_both": false,
          "description": "<string>",
          "page_age": "<string>",
          "page_fetched": "<string>",
          "fetched_content_timestamp": 123,
          "profile": {
            "name": "<string>",
            "url": "<string>",
            "long_name": "<string>",
            "img": "<string>"
          },
          "language": "<string>",
          "family_friendly": true,
          "meta_url": {
            "scheme": "<string>",
            "netloc": "<string>",
            "hostname": "<string>",
            "favicon": "<string>",
            "path": "<string>"
          }
        }
      ]
    }
  ]
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Headers

​
x-loc-lat
number | null

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.

Required range: -90 <= x <= 90
​
x-loc-long
number | null

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.

Required range: -180 <= x <= 180
​
x-subscription-token
string
required

The subscription token that was generated for the product.

Examples:

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

The default supported media type is application/json.

Available options:
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:
TitleConst
CacheControlno-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.

Examples:

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

​
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
​
search_lang
enum<string>

The search language preference. The 2 or more character language code for which the search results are provided.

Available options:
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
​
ui_lang
enum<string>

User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.

Available options:
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
​
units
enum<string> | null

Measurement units.

Available options:
imperial,
metric

Response

Successful Response

​
type
enum<string>
default:local_pois
Available options:
TitleConst
Typelocal_pois
​
results
Results · array

The list of location results (POIs) for the given location identifiers.

⌘I