web

View skill file Skill file for Place search

Search for points of interest in an area. If no q is provided, the endpoint will return general points of interest in the given area.

Authorization

x-subscription-token string header required
The subscription token that was generated for the product.

Query Parameters

q string
Query string to search for points of interest in an area. If no q is provided, the endpoint will return general points of interest in the given area.
Default: ""
latitude number
Latitude of the geographical coordinates.
longitude number
Longitude of the geographical coordinates.
location string

Location string to search for points of interest in an area. This is alternative to the latitude and longitude parameters.

  • For locations in US prefer the form <city> <state> <country name>, ie. san francisco ca united states
  • For non-US locations, use the form <city> <country name>, ie. tokyo japan
  • No need for commas or other special chars, capitalization does not matter
  • We cover multiple languages: nueva york instead of new york works, but using English or the most popular language on the target city should work the best
radius number
Search radius around the given coordinates, in meters. Search is performed globally if no radius is provided.
count integer
Number of results to return. The maximum is 50.
Min: 1 Max: 50 Default: 20
country enum<string>
Two-letter country code (ISO 3166-1 alpha-2) to scope the search.
Default: "US"
Available options: ARAUAT
search_lang enum<string>
Language for the search results.
Default: "en"
Available options: areubn
ui_lang enum<string>
User interface language for the response. Usually <language>-<region>.
Default: "en-US"
Available options: es-ARen-AUde-AT
units enum<string>
Units of measurement for distance values.
Default: "metric"
Available options: imperialmetric
safesearch enum<string>
Safe search level for the query results.
Default: "strict"
Available options: offmoderatestrict
spellcheck boolean
Whether to apply spellcheck before executing the search.
Default: true
geoloc string
Optional geolocation token used to refine results.

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
  • Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36 Android
  • 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 iOS
  • Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 macOS
  • Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 Windows
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 "locations"
query object nullable
results object[] nullable
location object nullable
A location
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