web
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
Query Parameters
radius number Search radius bias around the given coordinates, in meters. NOTE: This is not strictly the radius of the search (nor the resulting radius of the results), but rather a bias towards results that are closer to the given coordinates. Search is performed globally if no radius is provided.
country enum<string> Two-letter country code (ISO 3166-1 alpha-2) to scope the search.
Default:
"US"Available options:
ARAUAT 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 geoloc string Optional geolocation of the user in the format
<latitude>x<longitude>. Used to calculate distance values in results.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:
""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 yorkinstead ofnew yorkworks, but using English or the most popular language on the target city should work the best
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.36AndroidMozilla/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.1iOSMozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36macOSMozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36Windows
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 The query object containing the original and potentially spell-corrected query.
results object[] nullable The list of points of interest results for the given quer.
cities object[] nullable The list of city results for the given query.
addresses object[] nullable The list of address results for the given query.
streets object[] nullable The list of street results for the given query.
mixed object[] The list of mixed results for the given query.
location object nullable Information about location resolved from either the coordinates of the location string.