YYYY-MM-DD. Default is the
latest that is available. Read more about API versioning.
schema:
anyOf:
- type: string
- type: 'null'
title: API version
description: >-
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.
deprecated: false
- name: cache-control
in: header
required: false
description: >-
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.
schema:
anyOf:
- type: string
enum:
- no-cache
const: no-cache
title: CacheControl
- type: 'null'
title: Cache control
description: >-
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.
deprecated: false
- name: user-agent
in: header
required: false
description: >-
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.
schema:
anyOf:
- type: string
- type: 'null'
title: User agent
description: >-
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.
deprecated: false
examples:
Android:
value: >-
Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like
Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36
description: Android
iOS:
value: >-
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
description: iOS
macOS:
value: >-
Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36
description: macOS
Windows:
value: >-
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36
description: Windows
- name: count
in: query
required: false
description: Number of results to return. The maximum is 100.
schema:
type: integer
maximum: 100
minimum: 1
description: Number of results to return. The maximum is 100.
default: 20
title: Count
deprecated: false
- name: country
in: query
required: false
description: Two-letter country code (ISO 3166-1 alpha-2) to scope the search.
schema:
allOf:
- type: string
enum:
- AR
- AU
- AT
- BE
- BR
- CA
- CL
- DK
- FI
- FR
- DE
- GR
- HK
- IN
- ID
- IT
- JP
- KR
- MY
- MX
- NL
- NZ
- 'NO'
- CN
- PL
- PT
- PH
- RU
- SA
- ZA
- ES
- SE
- CH
- TW
- TR
- GB
- US
- ALL
title: SearchCountry
- default: US
description: Two-letter country code (ISO 3166-1 alpha-2) to scope the search.
deprecated: false
- name: geoloc
in: query
required: false
description: >-
Optional geolocation of the user in the format
<latitude>x<longitude>. Used to calculate
distance values in results.
schema:
anyOf:
- type: string
- type: 'null'
description: >-
Optional geolocation of the user in the format
<latitude>x<longitude>. Used to calculate
distance values in results.
title: Geoloc
deprecated: false
- name: latitude
in: query
required: false
description: Latitude of the geographical coordinates.
schema:
anyOf:
- type: number
maximum: 90
minimum: -90
- type: 'null'
description: Latitude of the geographical coordinates.
title: Latitude
deprecated: false
- name: location
in: query
required: false
description: >-
Location string to search for points of interest in an area.
This is alternative to the latitude and
longitude parameters.
<city>
<state> <country name>, ie. san francisco
ca united states<city>
<country name>, ie. tokyo japannueva york instead of
new york works, but using English or the most popular
language on the target city should work the bestLocation string to search for points of interest in an area.
This is alternative to the latitude and
longitude parameters.
<city>
<state> <country name>, ie. san francisco
ca united states<city>
<country name>, ie. tokyo japannueva york instead
of new york works, but using English or the most
popular language on the target city should work the bestq is provided, the endpoint will return general points
of interest in the given area.
schema:
type: string
description: >-
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: ''
title: Q
deprecated: false
- name: radius
in: query
required: false
description: >-
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.
schema:
anyOf:
- type: number
minimum: 0
- type: 'null'
description: >-
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.
title: Radius
deprecated: false
- name: safesearch
in: query
required: false
description: Safe search level for the query results.
schema:
allOf:
- type: string
enum:
- 'off'
- moderate
- strict
title: SafeSearch
- default: strict
description: Safe search level for the query results.
deprecated: false
- name: search_lang
in: query
required: false
description: Language for the search results.
schema:
allOf:
- type: string
enum:
- 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
- ja
- 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
title: Language
- default: en
description: Language for the search results.
deprecated: false
- name: spellcheck
in: query
required: false
description: Whether to apply spellcheck before executing the search.
schema:
type: boolean
description: Whether to apply spellcheck before executing the search.
default: true
title: Spellcheck
deprecated: false
- name: ui_lang
in: query
required: false
description: >-
User interface language for the response. Usually
<language>-<region>.
schema:
allOf:
- type: string
enum:
- 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
title: MarketCodes
- default: en-US
description: >-
User interface language for the response. Usually
<language>-<region>.
deprecated: false
- name: units
in: query
required: false
description: >-
Units of measurement for distance values: metric is
kilometres, imperial is miles.
schema:
allOf:
- type: string
enum:
- imperial
- metric
title: MeasurementUnit
- default: metric
description: >-
Units of measurement for distance values: metric is
kilometres, imperial is miles.
deprecated: false
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_LocalPlaceSearchApiResponse
default:
content:
application/json:
schema: {}
description: >-
Error response; upstream passthrough responses may use provider
formats
components:
schemas:
ResponseE3Baaa015480_LocalPlaceSearchApiResponse:
properties:
type:
type: string
enum:
- locations
const: locations
title: Type
default: locations
query:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_snakepit__models__search_api__responses__local__v1__Query
- type: 'null'
description: >-
The query object containing the original and potentially
spell-corrected query.
results:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
type: array
- type: 'null'
title: Results
description: The list of points of interest results for the given quer.
cities:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_CityResult'
type: array
- type: 'null'
title: Cities
description: The list of city results for the given query.
countries:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_CountryResult'
type: array
- type: 'null'
title: Countries
description: The list of country results for the given query.
regions:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_RegionResult'
type: array
- type: 'null'
title: Regions
description: The list of region results for the given query.
neighborhoods:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_NeighborhoodResult'
type: array
- type: 'null'
title: Neighborhoods
description: The list of neighborhood results for the given query.
addresses:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_AddressResult'
type: array
- type: 'null'
title: Addresses
description: The list of address results for the given query.
streets:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_AddressResult'
type: array
- type: 'null'
title: Streets
description: The list of street results for the given query.
mixed:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_ResultReference'
type: array
title: Mixed
description: The list of mixed results for the given query.
default: []
location:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_snakepit__models__search_api__responses__local__v1__Location
- type: 'null'
description: >-
Information about location resolved from either the coordinates of
the location string.
type: object
title: LocalPlaceSearchApiResponse
ResponseE3Baaa015480_snakepit__models__search_api__responses__local__v1__Query:
properties:
original:
type: string
title: Original
description: The original query that was requested.
altered:
anyOf:
- type: string
- type: 'null'
title: Altered
description: >-
The altered query by the spellchecker. This is the query that is
used to search.
spellcheck_off:
anyOf:
- type: boolean
- type: 'null'
title: Spellcheck Off
description: Whether the spellchecker is enabled or disabled.
show_strict_warning:
anyOf:
- type: boolean
- type: 'null'
title: Show Strict Warning
description: >-
The value is true if the lack of results is due to a
strict safesearch setting. Adult content relevant to
the query was found, but was blocked by safesearch.
type: object
required:
- original
title: Query
ResponseE3Baaa015480_LocationResult:
properties:
title:
type: string
title: Title
description: The title of the web page.
url:
type: string
title: Url
description: The URL where the page is served.
is_source_local:
type: boolean
title: Is Source Local
description: Whether the result is from a local source.
default: false
is_source_both:
type: boolean
title: Is Source Both
description: Whether the result is from both local and global sources.
default: false
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: A description for the web page.
default: ''
page_age:
anyOf:
- type: string
- type: 'null'
title: Page Age
description: The page’s date, based on its published or last modified date.
page_fetched:
anyOf:
- type: string
- type: 'null'
title: Page Fetched
description: A date representing when the web page was last fetched.
fetched_content_timestamp:
anyOf:
- type: integer
- type: 'null'
title: Fetched Content Timestamp
description: The timestamp when the content was fetched.
profile:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
- type: 'null'
description: A profile associated with the web page.
language:
anyOf:
- type: string
- type: 'null'
title: Language
description: A language classification for the web page.
family_friendly:
type: boolean
title: Family Friendly
description: Whether the web page is family friendly.
default: true
type:
type: string
enum:
- location_result
const: location_result
title: Type
description: >-
Location result type identifier. The value is always
location_result.
default: location_result
provider_url:
type: string
title: Provider Url
description: The complete URL of the provider.
coordinates:
anyOf:
- prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
- type: 'null'
title: Coordinates
description: >-
A list of coordinates associated with the location. This is a lat
long represented as a floating point.
zoom_level:
type: integer
title: Zoom Level
description: The zoom level on the map.
default: 7
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the location.
postal_address:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_PostalAddress'
- type: 'null'
description: The postal address associated with the location.
opening_hours:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_OpeningHours'
- type: 'null'
description: >-
The opening hours, if it is a business, associated with the
location.
contact:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Contact'
- type: 'null'
description: The contact of the business associated with the location.
price_range:
anyOf:
- type: string
- type: 'null'
title: Price Range
description: >-
A display string used to show the price classification for the
business.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: The ratings of the business.
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: The distance of the location from the client.
profiles:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Profiles
description: Profiles associated with the business.
reviews:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Reviews'
- type: 'null'
description: Aggregated reviews from various sources relevant to the business.
pictures:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_PictureResults'
- type: 'null'
description: A bunch of pictures associated with the business.
action:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Action'
- type: 'null'
description: An action to be taken.
serves_cuisine:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Serves Cuisine
description: A list of cuisine categories served.
categories:
items:
type: string
type: array
title: Categories
description: A list of categories.
default: []
icon_category:
anyOf:
- type: string
- type: 'null'
title: Icon Category
description: An icon category.
timezone:
anyOf:
- type: string
- type: 'null'
title: Timezone
description: IANA timezone identifier.
timezone_offset:
anyOf:
- type: integer
- type: 'null'
title: Timezone Offset
description: The UTC offset of the timezone.
id:
anyOf:
- type: string
- type: 'null'
title: Id
description: >-
A temporary id associated with this result, which can be used to
retrieve extra information about the location. It remains valid for
8 hours.
results:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_LocationWebResult'
type: array
- type: 'null'
title: Results
description: Web results related to this location.
type: object
required:
- title
- url
- provider_url
title: LocationResult
description: A result that is location relevant.
ResponseE3Baaa015480_CityResult:
properties:
type:
type: string
enum:
- city
const: city
title: Type
description: City result type identifier. The value is always city.
default: city
name:
type: string
title: Name
description: The name of the city.
country:
type: string
title: Country
description: The country of the city.
coordinates:
prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
title: Coordinates
description: A pair of coordinates (lat, long) for the city.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: Primary image for the city.
type: object
required:
- name
- country
- coordinates
- thumbnail
title: CityResult
description: A result representing a city.
ResponseE3Baaa015480_CountryResult:
properties:
type:
type: string
enum:
- country
const: country
title: Type
description: >-
Country result type identifier. The value is always
country.
default: country
name:
type: string
title: Name
description: The name of the country.
country:
type: string
title: Country
description: The country of the result.
coordinates:
prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
title: Coordinates
description: A pair of coordinates (lat, long) for the country.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: Primary image for the country.
type: object
required:
- name
- country
- coordinates
- thumbnail
title: CountryResult
description: A result representing a country.
ResponseE3Baaa015480_RegionResult:
properties:
type:
type: string
enum:
- region
const: region
title: Type
description: >-
Region result type identifier. The value is always
region.
default: region
name:
type: string
title: Name
description: The name of the region.
country:
type: string
title: Country
description: The country of the region.
coordinates:
prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
title: Coordinates
description: A pair of coordinates (lat, long) for the region.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: Primary image for the region.
type: object
required:
- name
- country
- coordinates
- thumbnail
title: RegionResult
description: A result representing a region (e.g. a state or province).
ResponseE3Baaa015480_NeighborhoodResult:
properties:
type:
type: string
enum:
- neighborhood
const: neighborhood
title: Type
description: >-
Neighborhood result type identifier. The value is always
neighborhood.
default: neighborhood
name:
type: string
title: Name
description: The name of the neighborhood.
country:
type: string
title: Country
description: The country of the neighborhood.
coordinates:
prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
title: Coordinates
description: A pair of coordinates (lat, long) for the neighborhood.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: Primary image for the neighborhood.
type: object
required:
- name
- country
- coordinates
- thumbnail
title: NeighborhoodResult
description: A result representing a neighborhood.
ResponseE3Baaa015480_AddressResult:
properties:
type:
type: string
enum:
- address
- street
title: Type
description: >-
Result type identifier. address when the result refers
to an explicit street + number, street when it refers
to the street itself.
default: address
name:
type: string
title: Name
description: The name of the address.
coordinates:
prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
title: Coordinates
description: A pair of coordinates (lat, long) for the address.
pois:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
type: array
title: Pois
description: POIs located at this address.
default: []
pois_nearby:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
type: array
title: Pois Nearby
description: POIs located nearby this address.
default: []
zoom_level:
type: integer
title: Zoom Level
description: Suggested zoom level on the map.
default: 15
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: Distance from the user’s geolocation, if available.
postal_address:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_PostalAddress'
- type: 'null'
description: Structured postal address.
type: object
required:
- name
- coordinates
title: AddressResult
description: A result representing a street address or a street.
ResponseE3Baaa015480_ResultReference:
properties:
type:
type: string
title: Type
description: The type of the result.
index:
anyOf:
- type: integer
- type: 'null'
title: Index
description: The 0th based index where the result should be placed.
all:
type: boolean
title: All
description: Whether to put all the results from the type at specific position.
default: false
type: object
required:
- type
title: ResultReference
description: The ranking order of results on a search result page.
ResponseE3Baaa015480_snakepit__models__search_api__responses__local__v1__Location:
properties:
coordinates:
prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
title: Coordinates
description: The latitude and longitude of the location.
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: The name of the location.
country:
anyOf:
- type: string
- type: 'null'
title: Country
description: The two letter country code of the location.
type: object
required:
- coordinates
title: Location
ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile:
properties:
name:
type: string
title: Name
description: The name of the profile.
url:
type: string
title: Url
description: The original URL where the profile is available.
long_name:
anyOf:
- type: string
- type: 'null'
title: Long Name
description: The long name of the profile.
img:
anyOf:
- type: string
- type: 'null'
title: Img
description: The served image URL representing the profile.
type: object
required:
- name
- url
title: Profile
description: A profile of an entity.
ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail:
properties:
src:
type: string
title: Src
description: The served URL of the picture thumbnail.
alt:
anyOf:
- type: string
- type: 'null'
title: Alt
description: The alt text for the thumbnail image.
height:
anyOf:
- type: integer
- type: 'null'
title: Height
description: The height of the thumbnail.
width:
anyOf:
- type: integer
- type: 'null'
title: Width
description: The width of the thumbnail.
bg_color:
anyOf:
- type: string
- type: 'null'
title: Bg Color
description: The background color of the thumbnail.
original:
anyOf:
- type: string
- type: 'null'
title: Original
description: The original URL of the image.
logo:
anyOf:
- type: boolean
- type: 'null'
title: Logo
description: Whether the thumbnail is a logo.
duplicated:
anyOf:
- type: boolean
- type: 'null'
title: Duplicated
description: Whether the thumbnail is a duplicate.
theme:
anyOf:
- type: string
- type: 'null'
title: Theme
description: The theme of the thumbnail (e.g., light or dark).
type: object
required:
- src
title: Thumbnail
description: Aggregated details representing a picture thumbnail.
ResponseE3Baaa015480_PostalAddress:
properties:
type:
type: string
enum:
- PostalAddress
const: PostalAddress
title: Type
description: >-
The type identifying a postal address. The value is always
PostalAddress.
default: PostalAddress
country:
anyOf:
- type: string
- type: 'null'
title: Country
description: The country associated with the location.
postalCode:
anyOf:
- type: string
- type: 'null'
title: Postalcode
description: The postal code associated with the location.
streetAddress:
anyOf:
- type: string
- type: 'null'
title: Streetaddress
description: The street address associated with the location.
addressRegion:
anyOf:
- type: string
- type: 'null'
title: Addressregion
description: The region associated with the location. This is usually a state.
addressLocality:
anyOf:
- type: string
- type: 'null'
title: Addresslocality
description: The address locality or subregion associated with the location.
displayAddress:
type: string
title: Displayaddress
description: The displayed address string.
type: object
required:
- displayAddress
title: PostalAddress
description: A model representing a postal address of a location.
ResponseE3Baaa015480_OpeningHours:
properties:
current_day:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_DayOpeningHours'
type: array
- type: 'null'
title: Current Day
description: The current day opening hours. Can have two sets of opening hours.
days:
anyOf:
- items:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_DayOpeningHours'
type: array
type: array
- type: 'null'
title: Days
description: The opening hours for the whole week.
type: object
title: OpeningHours
description: Opening hours of a business at a particular location.
ResponseE3Baaa015480_Contact:
properties:
email:
anyOf:
- type: string
- type: 'null'
title: Email
description: The email address.
telephone:
anyOf:
- type: string
- type: 'null'
title: Telephone
description: The telephone number.
type: object
title: Contact
description: A model representing contact information for an entity.
ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating:
properties:
ratingValue:
type: number
minimum: 0
title: Ratingvalue
description: The current value of the rating.
bestRating:
type: number
exclusiveMinimum: 0
title: Bestrating
description: Best rating received.
reviewCount:
anyOf:
- type: integer
- type: 'null'
title: Reviewcount
description: The number of reviews associated with the rating.
profile:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
- type: 'null'
description: The profile associated with the rating.
is_tripadvisor:
type: boolean
title: Is Tripadvisor
description: Whether the rating is coming from Tripadvisor.
default: false
type: object
required:
- ratingValue
- bestRating
title: Rating
description: The rating associated with an entity.
ResponseE3Baaa015480_Unit:
properties:
value:
type: number
title: Value
description: The quantity of the unit.
units:
type: string
title: Units
description: The name of the unit associated with the quantity.
type: object
required:
- value
- units
title: Unit
description: A model representing a unit of measurement.
ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider:
properties:
type:
type: string
enum:
- external
const: external
title: Type
description: >-
The type representing the source of data. This is usually
external.
default: external
name:
type: string
title: Name
description: The name of the data provider. This can be a domain.
url:
type: string
title: Url
description: The URL where the information is coming from.
long_name:
anyOf:
- type: string
- type: 'null'
title: Long Name
description: The long name for the data provider.
img:
anyOf:
- type: string
- type: 'null'
title: Img
description: The served URL for the image data.
type: object
required:
- name
- url
title: DataProvider
description: A model representing the data provider associated with the entity.
ResponseE3Baaa015480_Reviews:
properties:
results:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_TripadvisorReview'
type: array
title: Results
description: A list of trip advisor reviews for the entity.
viewMoreUrl:
type: string
title: Viewmoreurl
description: >-
A URL to a web page where more information on the result can be
seen.
reviews_in_foreign_language:
type: boolean
title: Reviews In Foreign Language
description: Any reviews available in a foreign language.
type: object
required:
- results
- viewMoreUrl
- reviews_in_foreign_language
title: Reviews
description: The reviews associated with an entity.
ResponseE3Baaa015480_PictureResults:
properties:
viewMoreUrl:
anyOf:
- type: string
- type: 'null'
title: Viewmoreurl
description: A URL to view more pictures.
results:
items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
type: array
title: Results
description: A list of thumbnail results.
type: object
required:
- viewMoreUrl
- results
title: PictureResults
description: A model representing a list of pictures.
ResponseE3Baaa015480_Action:
properties:
type:
type: string
title: Type
description: The type representing the action.
url:
type: string
title: Url
description: A URL representing the action to be taken.
type: object
required:
- type
- url
title: Action
description: A model representing an action to be taken.
ResponseE3Baaa015480_LocationWebResult:
properties:
title:
type: string
title: Title
description: The title of the web page.
url:
type: string
title: Url
description: The URL where the page is served.
is_source_local:
type: boolean
title: Is Source Local
description: Whether the result is from a local source.
default: false
is_source_both:
type: boolean
title: Is Source Both
description: Whether the result is from both local and global sources.
default: false
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: A description for the web page.
default: ''
page_age:
anyOf:
- type: string
- type: 'null'
title: Page Age
description: The page’s date, based on its published or last modified date.
page_fetched:
anyOf:
- type: string
- type: 'null'
title: Page Fetched
description: A date representing when the web page was last fetched.
fetched_content_timestamp:
anyOf:
- type: integer
- type: 'null'
title: Fetched Content Timestamp
description: The timestamp when the content was fetched.
profile:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
- type: 'null'
description: A profile associated with the web page.
language:
anyOf:
- type: string
- type: 'null'
title: Language
description: A language classification for the web page.
family_friendly:
type: boolean
title: Family Friendly
description: Whether the web page is family friendly.
default: true
meta_url:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__MetaUrl
description: Aggregated information about the URL.
type: object
required:
- title
- url
- meta_url
title: LocationWebResult
description: A model representing a web result related to a location.
ResponseE3Baaa015480_DayOpeningHours:
properties:
abbr_name:
type: string
title: Abbr Name
description: A short string representing the day of the week.
full_name:
type: string
title: Full Name
description: A full string representing the day of the week.
opens:
type: string
title: Opens
description: >-
A 24 hr clock time string for the opening time of the business on a
particular day.
closes:
type: string
title: Closes
description: >-
A 24 hr clock time string for the closing time of the business on a
particular day.
type: object
required:
- abbr_name
- full_name
- opens
- closes
title: DayOpeningHours
description: >-
A model representing the opening hours for a particular day for a
business at a particular location.
ResponseE3Baaa015480_TripadvisorReview:
properties:
title:
type: string
title: Title
description: The title of the review.
description:
type: string
title: Description
description: A description seen in the review.
date:
type: string
title: Date
description: The date when the review was published.
rating:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
description: A rating given by the reviewer.
author:
$ref: '#/components/schemas/ResponseE3Baaa015480_Person'
description: The author of the review.
review_url:
type: string
title: Review Url
description: A URL link to the page where the review can be found.
language:
type: string
title: Language
description: The language of the review.
type: object
required:
- title
- description
- date
- rating
- author
- review_url
- language
title: TripadvisorReview
description: A model representing a Tripadvisor review.
ResponseE3Baaa015480_app__models__products__search__v1__shared__MetaUrl:
properties:
scheme:
type: string
title: Scheme
description: The protocol scheme extracted from the URL.
netloc:
type: string
title: Netloc
description: The network location part extracted from the URL.
hostname:
anyOf:
- type: string
- type: 'null'
title: Hostname
description: The lowercased domain name extracted from the URL.
favicon:
type: string
title: Favicon
description: The favicon used for the URL.
path:
type: string
title: Path
description: The hierarchical path of the URL useful as a display string.
type: object
required:
- scheme
- netloc
- favicon
- path
title: MetaUrl
description: Aggregated information about a URL.
ResponseE3Baaa015480_Person:
properties:
type:
type: string
enum:
- person
const: person
title: Type
description: >-
A type identifying a person. The value is always
person.
default: person
name:
type: string
title: Name
description: The name of the thing.
url:
anyOf:
- type: string
- type: 'null'
title: Url
description: A URL for the thing.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: Thumbnail associated with the thing.
email:
anyOf:
- type: string
- type: 'null'
title: Email
description: Email address of the person.
type: object
required:
- name
title: Person
description: A model describing a person entity.
securitySchemes:
bearerAuth:
scheme: bearer
type: http
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.