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: x-loc-city
in: header
required: false
description: The generic name of the client city.
schema:
anyOf:
- type: string
- type: 'null'
title: City
description: The generic name of the client city.
deprecated: false
examples:
City in USA:
value: San Francisco
- name: x-loc-country
in: header
required: false
description: >-
The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2.
schema: anyOf: - type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: Country - type: 'null' title: Country code description: >-The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2.
examples: - US deprecated: false examples: '0': value: US - name: x-loc-lat in: header required: false description: >- The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees. schema: anyOf: - type: number maximum: 90 minimum: -90 - type: 'null' title: Latitude description: >- The latitude of the client’s geographical location in degrees, to provide relevant local results. The latitude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees. examples: - 37.787 deprecated: false examples: '0': value: 37.787 - name: x-loc-long in: header required: false description: >- 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. schema: anyOf: - type: number maximum: 180 minimum: -180 - type: 'null' title: Longitude description: >- 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. examples: - -122.4 deprecated: false examples: '0': value: -122.4 - name: x-loc-postal-code in: header required: false description: The client’s postal code. schema: anyOf: - type: string - type: 'null' title: Postal code description: The client’s postal code. deprecated: false examples: Postal code in San Francisco, California, US: value: '94105' - name: x-loc-state in: header required: false description: >- A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code. schema: anyOf: - type: string - type: 'null' title: State/Region code description: >- A code which could be up to three characters, that represent the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code. examples: - CA deprecated: false examples: '0': value: CA - name: x-loc-state-name in: header required: false description: >- The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code. schema: anyOf: - type: string - type: 'null' title: State/Region name description: >- The name of the client’s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code. examples: - California deprecated: false examples: '0': value: California - name: x-loc-timezone in: header required: false description: >- The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database. schema: anyOf: - type: string - type: 'null' title: IANA timezone description: >- The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database. deprecated: false examples: IANA timezone for San Francisco in USA: value: America/San_Francisco requestBody: required: true description: '' content: application/json: schema: properties: q: type: string maxLength: 600 minLength: 1 title: Query description: >- The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query. country: 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 title: Search country description: >- The 2 character country code where the search results come from. search_lang: 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 title: Search language description: >- The 2 or more character language code for which the search results are provided. ui_lang: 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 title: User interface language description: >- User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110. count: type: integer maximum: 20 minimum: 1 title: Count description: >-The number of search results returned in response. The maximum is 20. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.
NOTE: Count only applies to web results.
default: 20 offset: type: integer maximum: 9 minimum: 0 title: Offset description: >-The zero based offset that indicates number of search result pages (count) to skip before returning the result. The default is 0 and the maximum is 9. The actual number delivered may be less than requested.
Use this parameter along with the count parameter to page results. For example, if your user interface displays 10 search results per page, set count to 10 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 1 (for example, 0, 1, 2). It is possible for multiple pages to include some overlap in results.
default: 0 safesearch: allOf: - type: string enum: - 'off' - moderate - strict title: SafeSearch - default: moderate title: Safe search description: >-Filters search results for adult content. The following values are supported:
Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:
2022-04-01to2022-07-30.A comma delimited string of result types to include in
the search response.
Not specifying this parameter will return back all result
types in search response where data is available
and the plan has the corresponding option activated. The
response always includes query and type to
identify any query modifications and response type
respectively.
Available result filter values are:
discussions, faq,
infobox, news, query,
summarizer, videos,
web, locations.
NOTE: count param only applies to web results.
examples: - '' - web - videos - web,videos units: anyOf: - type: string enum: - imperial - metric title: MeasurementUnit - type: 'null' title: Units description: >-The measurement units. The following values are supported:
Enable rich callback. Allows you to get real time rich results via a callback URL when they are relevant to your query.
NOTE: Requires Search
plan.
search.
default: search
results:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_DiscussionResult'
type: array
title: Results
description: A list of discussion results.
mutated_by_goggles:
type: boolean
title: Mutated By Goggles
description: >-
Whether the discussion results are changed by Goggles. The value is
false by default.
default: false
type: object
required:
- results
title: Discussions
description: A model representing a discussion cluster relevant to the query.
ResponseE3Baaa015480_app__models__products__search__v1__faq__FAQ:
properties:
type:
type: string
enum:
- faq
const: faq
title: Type
description: >-
The FAQ result type identifier. The value is always
faq.
default: faq
results:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_QA'
type: array
title: Results
description: A list of aggregated question answer results relevant to the query.
type: object
required:
- results
title: FAQ
description: Frequently asked questions relevant to the search query term.
ResponseE3Baaa015480_GraphInfobox:
properties:
type:
type: string
enum:
- graph
const: graph
title: Type
description: >-
The type identifier for infoboxes. The value is always
graph.
default: graph
results:
items:
oneOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_GenericInfobox'
- $ref: '#/components/schemas/ResponseE3Baaa015480_QAInfobox'
- $ref: '#/components/schemas/ResponseE3Baaa015480_InfoboxPlace'
- $ref: '#/components/schemas/ResponseE3Baaa015480_InfoboxWithLocation'
- $ref: '#/components/schemas/ResponseE3Baaa015480_EntityInfobox'
discriminator:
propertyName: subtype
mapping:
code: '#/components/schemas/ResponseE3Baaa015480_QAInfobox'
entity: '#/components/schemas/ResponseE3Baaa015480_EntityInfobox'
generic: '#/components/schemas/ResponseE3Baaa015480_GenericInfobox'
location: '#/components/schemas/ResponseE3Baaa015480_InfoboxWithLocation'
place: '#/components/schemas/ResponseE3Baaa015480_InfoboxPlace'
type: array
title: Results
description: A list of infoboxes associated with the query.
type: object
required:
- results
title: GraphInfobox
description: Aggregated information on an entity shown as an infobox.
ResponseE3Baaa015480_Locations:
properties:
type:
type: string
enum:
- locations
const: locations
title: Type
description: >-
Location type identifier. The value is always
locations.
default: locations
results:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
type: array
title: Results
description: An aggregated list of location sensitive results.
provider:
anyOf:
- type: object
- type: 'null'
title: Provider
description: The provider of the location data.
type: object
required:
- results
title: Locations
description: A model representing location results.
ResponseE3Baaa015480_MixedResponse:
properties:
type:
type: string
enum:
- mixed
const: mixed
title: Type
description: >-
The type representing the model mixed. The value is always
mixed.
default: mixed
main:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_ResultReference'
type: array
- type: 'null'
title: Main
description: The ranking order for the main section of the search result page.
top:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_ResultReference'
type: array
- type: 'null'
title: Top
description: The ranking order for the top section of the search result page.
side:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_ResultReference'
type: array
- type: 'null'
title: Side
description: The ranking order for the side section of the search result page.
type: object
title: MixedResponse
description: The ranking order of results on a search result page.
ResponseE3Baaa015480_News:
properties:
type:
type: string
enum:
- news
const: news
title: Type
description: The type of API result. The value is always news.
default: news
results:
items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__NewsResult
type: array
title: Results
description: The list of news results.
mutated_by_goggles:
type: boolean
title: Mutated By Goggles
description: Whether the results are mutated by a goggle.
default: false
type: object
required:
- results
title: News
ResponseE3Baaa015480_Videos:
properties:
type:
type: string
enum:
- videos
const: videos
title: Type
description: The type of API result. The value is always videos.
default: videos
results:
items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__videos__VideoResult
type: array
title: Results
description: The list of video results.
mutated_by_goggles:
type: boolean
title: Mutated By Goggles
description: Whether the results are mutated by a goggle.
default: false
type: object
required:
- results
title: Videos
ResponseE3Baaa015480_Search:
properties:
type:
type: string
enum:
- search
const: search
title: Type
description: >-
A type identifying web search results. The value is always
search.
default: search
results:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_SearchResult'
type: array
title: Results
description: A list of search results.
family_friendly:
type: boolean
title: Family Friendly
description: Whether the results are family friendly.
default: true
type: object
required:
- results
title: Search
description: A model representing a collection of web search results.
ResponseE3Baaa015480_Summarizer:
properties:
type:
type: string
enum:
- summarizer
const: summarizer
title: Type
description: The type of result. The value is always summarizer.
default: summarizer
key:
type: string
title: Key
description: The key to retrieve the full summary results.
type: object
required:
- key
title: Summarizer
ResponseE3Baaa015480_RichHeaderCallback:
properties:
type:
type: string
enum:
- rich
const: rich
title: Type
default: rich
hint:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_ResponseCallback'
- type: 'null'
type: object
title: RichHeaderCallback
ResponseE3Baaa015480_app__models__products__search__v1__language__Language:
properties:
main:
type: string
title: Main
description: The main language seen in the string.
type: object
required:
- main
title: Language
description: A model representing a language.
ResponseE3Baaa015480_SearchOperators:
properties:
applied:
type: boolean
title: Applied
description: Whether search operators were applied to the query.
default: false
cleaned_query:
anyOf:
- type: string
- type: 'null'
title: Cleaned Query
description: The query after search operators have been processed.
sites:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Sites
description: 'List of site domains extracted from site: operators.'
type: object
title: SearchOperators
ResponseE3Baaa015480_DiscussionResult:
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:
type: string
title: Language
description: The main language on the web search result.
default: en
family_friendly:
type: boolean
title: Family Friendly
description: Whether the web page is family friendly.
default: true
type:
type: string
enum:
- discussion
const: discussion
title: Type
description: >-
The discussion result type identifier. The value is always
discussion.
default: discussion
subtype:
type: string
title: Subtype
description: A sub type identifying the web search result type.
default: generic
is_live:
type: boolean
title: Is Live
description: >-
Whether the web search result is currently live. Default value is
false.
default: false
deep_results:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_DeepResult'
- type: 'null'
description: Gathered information on a web search result.
schemas:
anyOf:
- items: {}
type: array
- type: 'null'
title: Schemas
description: >-
A list of schemas (structured data) extracted from the page. The
schemas try to follow schema.org and
will return anything we can extract from the HTML that can fit into
these models.
meta_url:
anyOf:
- type: object
- type: 'null'
title: Meta Url
description: >-
Aggregated information on the URL associated with the web search
result.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail of the web search result.
age:
anyOf:
- type: string
- type: 'null'
title: Age
description: >-
A human-readable representation of the web search result’s age. For
example, 2 days ago.
location:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
- type: 'null'
description: The location details if the query relates to a restaurant.
restaurant:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
- type: 'null'
description: Deprecated. Use location instead.
deprecated: true
video:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__VideoData
- type: 'null'
description: The video associated with the web search result.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: The movie associated with the web search result.
faq:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__FAQ
- type: 'null'
description: >-
Any frequently asked questions associated with the web search
result.
qa:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_QAPage'
- type: 'null'
description: >-
Any question answer information associated with the web search
result page.
book:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Book'
- type: 'null'
description: Any book information associated with the web search result page.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: Rating found for the web search result page.
article:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Article'
- type: 'null'
description: An article found for the web search result page.
product:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Product
- $ref: '#/components/schemas/ResponseE3Baaa015480_Review'
- type: 'null'
title: Product
description: >-
The main product and a review that is found on the web search result
page.
product_cluster:
anyOf:
- items:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Product
- $ref: '#/components/schemas/ResponseE3Baaa015480_Review'
type: array
- type: 'null'
title: Product Cluster
description: >-
A list of products and reviews that are found on the web search
result page.
cluster_type:
anyOf:
- type: string
- type: 'null'
title: Cluster Type
description: A type representing a cluster. The value can be product_cluster.
cluster:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Result'
type: array
- type: 'null'
title: Cluster
description: A list of web search results.
creative_work:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_CreativeWork'
- type: 'null'
description: >-
Aggregated information on the creative work found on the web search
result.
music_recording:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MusicRecording'
- type: 'null'
description: >-
Aggregated information on music recording found on the web search
result.
review:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Review'
- type: 'null'
description: Aggregated information on the review found on the web search result.
recipe:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Recipe'
- type: 'null'
description: >-
Aggregated information on a recipe found on the web search result
page.
software:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Software'
- type: 'null'
description: >-
Aggregated information on a software product found on the web search
result page.
organization:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Organization'
- type: 'null'
description: >-
Aggregated information on a organization found on the web search
result page.
content_type:
anyOf:
- type: string
- type: 'null'
title: Content Type
description: The content type associated with the search result page.
extra_snippets:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Extra Snippets
description: A list of extra alternate snippets for the web search result.
icons:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_PostprocessedIcon'
type: array
- type: 'null'
title: Icons
description: Icons associated with the search result.
data:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_ForumData'
- type: 'null'
description: The enriched aggregated data for the relevant forum post.
type: object
required:
- title
- url
title: DiscussionResult
description: >-
A discussion result. These are forum posts and discussions that are
relevant to the search query.
ResponseE3Baaa015480_QA:
properties:
question:
type: string
title: Question
description: The question being asked.
answer:
type: string
title: Answer
description: The answer to the question.
title:
type: string
title: Title
description: The title of the post.
url:
type: string
title: Url
description: The URL pointing to the post.
meta_url:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__MetaUrl
- type: 'null'
description: Aggregated information about the URL.
type: object
required:
- question
- answer
- title
- url
title: QA
description: A question/answer result.
ResponseE3Baaa015480_GenericInfobox:
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:
- infobox
const: infobox
title: Type
description: >-
The infobox result type identifier. The value is always
infobox.
default: infobox
position:
type: integer
title: Position
description: The position on a search result page.
label:
anyOf:
- type: string
- type: 'null'
title: Label
description: Any label associated with the entity.
category:
anyOf:
- type: string
- type: 'null'
title: Category
description: Category classification for the entity.
long_desc:
anyOf:
- type: string
- type: 'null'
title: Long Desc
description: A longer description for the entity.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the entity.
attributes:
items:
items:
anyOf:
- type: string
- type: 'null'
type: array
maxItems: 2
minItems: 2
type: array
title: Attributes
description: A list of attributes about the entity.
default: []
profiles:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
type: array
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Profiles
description: The profiles associated with the entity.
website_url:
anyOf:
- type: string
- type: 'null'
title: Website Url
description: The official website pertaining to the entity.
ratings:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
type: array
- type: 'null'
title: Ratings
description: Any ratings given to the entity.
providers:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Providers
description: A list of data sources for the entity.
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: A unit representing quantity relevant to the entity.
images:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
type: array
- type: 'null'
title: Images
description: A list of images relevant to the entity.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: >-
Any movie data relevant to the entity. Appears only when the result
is a movie.
subtype:
type: string
enum:
- generic
const: generic
title: Subtype
description: >-
The infobox subtype identifier. The value is always
generic.
default: generic
found_in_urls:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Found In Urls
description: List of URLs where the entity was found.
type: object
required:
- title
- url
- position
title: GenericInfobox
description: Aggregated information on a generic entity from a knowledge graph.
ResponseE3Baaa015480_QAInfobox:
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:
- infobox
const: infobox
title: Type
description: >-
The infobox result type identifier. The value is always
infobox.
default: infobox
position:
type: integer
title: Position
description: The position on a search result page.
label:
anyOf:
- type: string
- type: 'null'
title: Label
description: Any label associated with the entity.
category:
anyOf:
- type: string
- type: 'null'
title: Category
description: Category classification for the entity.
long_desc:
anyOf:
- type: string
- type: 'null'
title: Long Desc
description: A longer description for the entity.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the entity.
attributes:
items:
items:
anyOf:
- type: string
- type: 'null'
type: array
maxItems: 2
minItems: 2
type: array
title: Attributes
description: A list of attributes about the entity.
default: []
profiles:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
type: array
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Profiles
description: The profiles associated with the entity.
website_url:
anyOf:
- type: string
- type: 'null'
title: Website Url
description: The official website pertaining to the entity.
ratings:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
type: array
- type: 'null'
title: Ratings
description: Any ratings given to the entity.
providers:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Providers
description: A list of data sources for the entity.
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: A unit representing quantity relevant to the entity.
images:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
type: array
- type: 'null'
title: Images
description: A list of images relevant to the entity.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: >-
Any movie data relevant to the entity. Appears only when the result
is a movie.
subtype:
type: string
enum:
- code
const: code
title: Subtype
description: >-
The infobox subtype identifier. The value is always
code.
default: code
data:
$ref: '#/components/schemas/ResponseE3Baaa015480_QAPage'
description: The question and relevant answer.
meta_url:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__MetaUrl
- type: 'null'
description: >-
Detailed information on the page containing the question and
relevant answer.
type: object
required:
- title
- url
- position
- data
title: QAInfobox
description: A question answer infobox.
ResponseE3Baaa015480_InfoboxPlace:
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:
- infobox
const: infobox
title: Type
description: >-
The infobox result type identifier. The value is always
infobox.
default: infobox
position:
type: integer
title: Position
description: The position on a search result page.
label:
anyOf:
- type: string
- type: 'null'
title: Label
description: Any label associated with the entity.
category:
anyOf:
- type: string
- type: 'null'
title: Category
description: Category classification for the entity.
long_desc:
anyOf:
- type: string
- type: 'null'
title: Long Desc
description: A longer description for the entity.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the entity.
attributes:
items:
items:
anyOf:
- type: string
- type: 'null'
type: array
maxItems: 2
minItems: 2
type: array
title: Attributes
description: A list of attributes about the entity.
default: []
profiles:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
type: array
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Profiles
description: The profiles associated with the entity.
website_url:
anyOf:
- type: string
- type: 'null'
title: Website Url
description: The official website pertaining to the entity.
ratings:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
type: array
- type: 'null'
title: Ratings
description: Any ratings given to the entity.
providers:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Providers
description: A list of data sources for the entity.
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: A unit representing quantity relevant to the entity.
images:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
type: array
- type: 'null'
title: Images
description: A list of images relevant to the entity.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: >-
Any movie data relevant to the entity. Appears only when the result
is a movie.
subtype:
type: string
enum:
- place
const: place
title: Subtype
description: >-
The infobox subtype identifier. The value is always
place.
default: place
found_in_urls:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Found In Urls
description: List of URLs where the entity was found.
is_location:
type: boolean
title: Is Location
description: Whether the entity is a location.
default: false
coordinates:
anyOf:
- prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
- type: 'null'
title: Coordinates
description: The coordinates of the location.
zoom_level:
anyOf:
- type: integer
- type: 'null'
title: Zoom Level
description: The map zoom level.
location:
$ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
description: The location result.
type: object
required:
- title
- url
- position
- location
title: InfoboxPlace
description: An infobox for a place, such as a business.
ResponseE3Baaa015480_InfoboxWithLocation:
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:
- infobox
const: infobox
title: Type
description: >-
The infobox result type identifier. The value is always
infobox.
default: infobox
position:
type: integer
title: Position
description: The position on a search result page.
label:
anyOf:
- type: string
- type: 'null'
title: Label
description: Any label associated with the entity.
category:
anyOf:
- type: string
- type: 'null'
title: Category
description: Category classification for the entity.
long_desc:
anyOf:
- type: string
- type: 'null'
title: Long Desc
description: A longer description for the entity.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the entity.
attributes:
items:
items:
anyOf:
- type: string
- type: 'null'
type: array
maxItems: 2
minItems: 2
type: array
title: Attributes
description: A list of attributes about the entity.
default: []
profiles:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
type: array
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Profiles
description: The profiles associated with the entity.
website_url:
anyOf:
- type: string
- type: 'null'
title: Website Url
description: The official website pertaining to the entity.
ratings:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
type: array
- type: 'null'
title: Ratings
description: Any ratings given to the entity.
providers:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Providers
description: A list of data sources for the entity.
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: A unit representing quantity relevant to the entity.
images:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
type: array
- type: 'null'
title: Images
description: A list of images relevant to the entity.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: >-
Any movie data relevant to the entity. Appears only when the result
is a movie.
subtype:
type: string
enum:
- location
const: location
title: Subtype
description: >-
The infobox subtype identifier. The value is always
location.
default: location
found_in_urls:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Found In Urls
description: List of URLs where the entity was found.
is_location:
type: boolean
title: Is Location
description: Whether the entity is a location.
default: false
coordinates:
anyOf:
- prefixItems:
- type: number
- type: number
type: array
maxItems: 2
minItems: 2
- type: 'null'
title: Coordinates
description: The coordinates of the location.
zoom_level:
anyOf:
- type: integer
- type: 'null'
title: Zoom Level
description: The map zoom level.
location:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
- type: 'null'
description: The location result.
type: object
required:
- title
- url
- position
title: InfoboxWithLocation
description: An infobox with location.
ResponseE3Baaa015480_EntityInfobox:
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:
- infobox
const: infobox
title: Type
description: >-
The infobox result type identifier. The value is always
infobox.
default: infobox
position:
type: integer
title: Position
description: The position on a search result page.
label:
anyOf:
- type: string
- type: 'null'
title: Label
description: Any label associated with the entity.
category:
anyOf:
- type: string
- type: 'null'
title: Category
description: Category classification for the entity.
long_desc:
anyOf:
- type: string
- type: 'null'
title: Long Desc
description: A longer description for the entity.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the entity.
attributes:
items:
items:
anyOf:
- type: string
- type: 'null'
type: array
maxItems: 2
minItems: 2
type: array
title: Attributes
description: A list of attributes about the entity.
default: []
profiles:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
type: array
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Profiles
description: The profiles associated with the entity.
website_url:
anyOf:
- type: string
- type: 'null'
title: Website Url
description: The official website pertaining to the entity.
ratings:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
type: array
- type: 'null'
title: Ratings
description: Any ratings given to the entity.
providers:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__DataProvider
type: array
- type: 'null'
title: Providers
description: A list of data sources for the entity.
distance:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Unit'
- type: 'null'
description: A unit representing quantity relevant to the entity.
images:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
type: array
- type: 'null'
title: Images
description: A list of images relevant to the entity.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: >-
Any movie data relevant to the entity. Appears only when the result
is a movie.
subtype:
type: string
enum:
- entity
const: entity
title: Subtype
description: >-
The infobox subtype identifier. The value is always
entity.
default: entity
type: object
required:
- title
- url
- position
title: EntityInfobox
description: Aggregated information on an entity from a knowledge graph.
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_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_app__models__products__search__v1__shared__NewsResult:
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:
anyOf:
- type: object
- type: 'null'
title: Meta Url
description: The aggregated information on the URL representing a news result.
source:
anyOf:
- type: string
- type: 'null'
title: Source
description: The source of the news.
breaking:
type: boolean
title: Breaking
description: Whether the news result is currently a breaking news.
default: false
is_live:
type: boolean
title: Is Live
description: Whether the news result is currently live.
default: false
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail associated with the news result.
age:
anyOf:
- type: string
- type: 'null'
title: Age
description: >-
A human-readable representation of the news article’s age. For
example, 2 days ago.
extra_snippets:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Extra Snippets
description: A list of extra alternate snippets for the news search result.
icons:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_PostprocessedIcon'
type: array
- type: 'null'
title: Icons
description: Icons associated with the news result.
type: object
required:
- title
- url
title: NewsResult
description: A model representing news results.
ResponseE3Baaa015480_app__models__products__search__v1__videos__VideoResult:
properties:
type:
type: string
enum:
- video_result
const: video_result
title: Type
description: >-
The type of video search API result. The value is always
video_result.
default: video_result
url:
type: string
title: Url
description: The source URL of the video.
title:
type: string
title: Title
description: The title of the video.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: The description for the video.
age:
anyOf:
- type: string
- type: 'null'
title: Age
description: >-
A human-readable representation of the video’s age. For example,
2 days ago.
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: >-
The ISO date time when the page was last fetched. The format is
YYYY-MM-DDTHH:MM:SSZ.
fetched_content_timestamp:
anyOf:
- type: integer
- type: 'null'
title: Fetched Content Timestamp
description: The timestamp when the content was fetched.
video:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__videos__VideoData
- type: 'null'
description: Metadata for the video.
meta_url:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__videos__MetaUrl
- type: 'null'
description: >-
Aggregated information on the URL associated with the video search
result.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__videos__Thumbnail
- type: 'null'
description: The thumbnail for the video.
type: object
required:
- url
- title
title: VideoResult
ResponseE3Baaa015480_SearchResult:
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:
type: string
title: Language
description: The main language on the web search result.
default: en
family_friendly:
type: boolean
title: Family Friendly
description: Whether the web page is family friendly.
default: true
type:
type: string
enum:
- search_result
const: search_result
title: Type
description: >-
A type identifying a web search result. The value is always
search_result.
default: search_result
subtype:
type: string
title: Subtype
description: A sub type identifying the web search result type.
default: generic
is_live:
type: boolean
title: Is Live
description: >-
Whether the web search result is currently live. Default value is
false.
default: false
deep_results:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_DeepResult'
- type: 'null'
description: Gathered information on a web search result.
schemas:
anyOf:
- items: {}
type: array
- type: 'null'
title: Schemas
description: >-
A list of schemas (structured data) extracted from the page. The
schemas try to follow schema.org and
will return anything we can extract from the HTML that can fit into
these models.
meta_url:
anyOf:
- type: object
- type: 'null'
title: Meta Url
description: >-
Aggregated information on the URL associated with the web search
result.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail of the web search result.
age:
anyOf:
- type: string
- type: 'null'
title: Age
description: >-
A human-readable representation of the web search result’s age. For
example, 2 days ago.
location:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
- type: 'null'
description: The location details if the query relates to a restaurant.
restaurant:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_LocationResult'
- type: 'null'
description: Deprecated. Use location instead.
deprecated: true
video:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__VideoData
- type: 'null'
description: The video associated with the web search result.
movie:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MovieData'
- type: 'null'
description: The movie associated with the web search result.
faq:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__FAQ
- type: 'null'
description: >-
Any frequently asked questions associated with the web search
result.
qa:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_QAPage'
- type: 'null'
description: >-
Any question answer information associated with the web search
result page.
book:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Book'
- type: 'null'
description: Any book information associated with the web search result page.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: Rating found for the web search result page.
article:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Article'
- type: 'null'
description: An article found for the web search result page.
product:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Product
- $ref: '#/components/schemas/ResponseE3Baaa015480_Review'
- type: 'null'
title: Product
description: >-
The main product and a review that is found on the web search result
page.
product_cluster:
anyOf:
- items:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Product
- $ref: '#/components/schemas/ResponseE3Baaa015480_Review'
type: array
- type: 'null'
title: Product Cluster
description: >-
A list of products and reviews that are found on the web search
result page.
cluster_type:
anyOf:
- type: string
- type: 'null'
title: Cluster Type
description: A type representing a cluster. The value can be product_cluster.
cluster:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Result'
type: array
- type: 'null'
title: Cluster
description: A list of web search results.
creative_work:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_CreativeWork'
- type: 'null'
description: >-
Aggregated information on the creative work found on the web search
result.
music_recording:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_MusicRecording'
- type: 'null'
description: >-
Aggregated information on music recording found on the web search
result.
review:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Review'
- type: 'null'
description: Aggregated information on the review found on the web search result.
recipe:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Recipe'
- type: 'null'
description: >-
Aggregated information on a recipe found on the web search result
page.
software:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Software'
- type: 'null'
description: >-
Aggregated information on a software product found on the web search
result page.
organization:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Organization'
- type: 'null'
description: >-
Aggregated information on a organization found on the web search
result page.
content_type:
anyOf:
- type: string
- type: 'null'
title: Content Type
description: The content type associated with the search result page.
extra_snippets:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Extra Snippets
description: A list of extra alternate snippets for the web search result.
icons:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_PostprocessedIcon'
type: array
- type: 'null'
title: Icons
description: Icons associated with the search result.
type: object
required:
- title
- url
title: SearchResult
description: Aggregated information on a web search result, relevant to the query.
ResponseE3Baaa015480_ResponseCallback:
properties:
vertical:
$ref: '#/components/schemas/ResponseE3Baaa015480_SearchAPIVertical'
description: >-
The vertical associated with the callback. For the full list of
verticals supported see the Rich Vertical list.
callback_key:
type: string
title: Callback Key
description: The unique key for the callback.
type: object
required:
- vertical
- callback_key
title: ResponseCallback
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_DeepResult:
properties:
news:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__NewsResult
type: array
- type: 'null'
title: News
description: A list of news results associated with the result.
buttons:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_ButtonResult'
type: array
- type: 'null'
title: Buttons
description: A list of buttoned results associated with the result.
videos:
anyOf:
- items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__VideoResult
type: array
- type: 'null'
title: Videos
description: Videos associated with the result.
images:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Image'
type: array
- type: 'null'
title: Images
description: Images associated with the result.
type: object
title: DeepResult
description: Aggregated deep results from news, social, videos and images.
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_app__models__products__search__v1__shared__VideoData:
properties:
duration:
anyOf:
- type: string
- type: 'null'
title: Duration
description: >-
A time string representing the duration of the video. The format can
be HH:MM:SS or MM:SS.
views:
anyOf:
- type: string
- type: 'null'
title: Views
description: The number of views of the video.
creator:
anyOf:
- type: string
- type: 'null'
title: Creator
description: The creator of the video.
publisher:
anyOf:
- type: string
- type: 'null'
title: Publisher
description: The publisher of the video.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: A thumbnail associated with the video.
tags:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tags
description: A list of tags associated with the video.
author:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile
- type: 'null'
description: Author of the video.
requires_subscription:
anyOf:
- type: boolean
- type: 'null'
title: Requires Subscription
description: Whether the video requires a subscription to watch.
type: object
title: VideoData
description: A model representing metadata gathered for a video.
ResponseE3Baaa015480_MovieData:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Name of the movie.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: A short plot summary for the movie.
url:
anyOf:
- type: string
- type: 'null'
title: Url
description: A URL serving a movie profile page.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: A thumbnail for a movie poster.
release:
anyOf:
- type: string
- type: 'null'
title: Release
description: The release date for the movie.
directors:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Person'
type: array
- type: 'null'
title: Directors
description: A list of people responsible for directing the movie.
actors:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Person'
type: array
- type: 'null'
title: Actors
description: A list of actors in the movie.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: Rating provided to the movie from various sources.
duration:
anyOf:
- type: string
- type: 'null'
title: Duration
description: The runtime of the movie. The format is HH:MM:SS.
genre:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Genre
description: List of genres in which the movie can be classified.
query:
anyOf:
- type: string
- type: 'null'
title: Query
description: The query that resulted in the movie result.
type: object
title: MovieData
description: Aggregated data for a movie result.
ResponseE3Baaa015480_app__models__products__search__v1__shared__FAQ:
properties:
items:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_QA'
type: array
title: Items
description: A list of question/answer pairs.
type: object
required:
- items
title: FAQ
description: Frequently asked questions associated with a search result.
ResponseE3Baaa015480_QAPage:
properties:
question:
type: string
title: Question
description: The question that is being asked.
answer:
$ref: '#/components/schemas/ResponseE3Baaa015480_Answer'
description: An answer to the question.
type: object
required:
- question
- answer
title: QAPage
description: Aggregated result from a question answer page.
ResponseE3Baaa015480_Book:
properties:
title:
type: string
title: Title
description: The title of the book.
author:
items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Person'
type: array
title: Author
description: The author of the book.
date:
anyOf:
- type: string
- type: 'null'
title: Date
description: The publishing date of the book.
price:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Price'
- type: 'null'
description: The price of the book.
pages:
anyOf:
- type: integer
- type: 'null'
title: Pages
description: The number of pages in the book.
publisher:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Person'
- type: 'null'
description: The publisher of the book.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: A gathered rating from different sources associated with the book.
type: object
required:
- title
- author
title: Book
description: A model representing a book result.
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_Article:
properties:
author:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_Person'
type: array
- type: 'null'
title: Author
description: The author of the article.
date:
anyOf:
- type: string
- type: 'null'
title: Date
description: The date when the article was published.
publisher:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_Organization'
- type: 'null'
description: The name of the publisher for the article.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: A thumbnail associated with the article.
isAccessibleForFree:
anyOf:
- type: boolean
- type: 'null'
title: Isaccessibleforfree
description: Whether the article is free to read or is behind a paywall.
type: object
title: Article
description: A model representing an article.
ResponseE3Baaa015480_app__models__products__search__v1__shared__Product:
properties:
type:
type: string
enum:
- Product
const: Product
title: Type
description: >-
A string representing a product type. The value is always
Product.
default: Product
name:
type: string
minLength: 1
title: Name
description: The name of the product.
url:
anyOf:
- type: string
- type: 'null'
title: Url
description: The URL of the product page.
category:
anyOf:
- type: string
- type: 'null'
title: Category
description: The category of the product.
price:
type: string
title: Price
description: The price of the product.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: A thumbnail associated with the product.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: The description of the product.
offers:
items:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Offer
type: array
title: Offers
description: A list of offers available on the product.
default: []
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: A rating associated with the product.
gtin:
anyOf:
- type: string
- type: 'null'
title: Gtin
description: A Global Trade Item Number (GTIN) for the product.
gtin8:
anyOf:
- type: string
- type: 'null'
title: Gtin8
description: The GTIN-8 (EAN/UCC-8) code of the product.
gtin12:
anyOf:
- type: string
- type: 'null'
title: Gtin12
description: The GTIN-12 (UPC) code of the product.
gtin13:
anyOf:
- type: string
- type: 'null'
title: Gtin13
description: The GTIN-13 (EAN/ISBN-13) code of the product.
gtin14:
anyOf:
- type: string
- type: 'null'
title: Gtin14
description: The GTIN-14 code of the product.
type: object
required:
- name
- price
- thumbnail
title: Product
description: A model representing a product.
ResponseE3Baaa015480_Review:
properties:
type:
type: string
enum:
- Review
const: Review
title: Type
description: >-
A string representing review type. This is always
Review.
default: Review
name:
type: string
title: Name
description: The review title for the review.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: The thumbnail associated with the reviewer.
description:
type: string
title: Description
description: A description of the review (the text of the review itself).
rating:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
description: The ratings associated with the review.
type: object
required:
- name
- thumbnail
- description
- rating
title: Review
description: A model representing a review for an entity.
ResponseE3Baaa015480_Result:
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: object
required:
- title
- url
title: Result
description: A model representing a web search result.
ResponseE3Baaa015480_CreativeWork:
properties:
name:
type: string
minLength: 1
title: Name
description: The name of the creative work.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: A rating that is given to the creative work.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: A thumbnail associated with the creative work.
type: object
required:
- name
- thumbnail
title: CreativeWork
description: >-
A creative work relevant to the query. An example can be enriched
metadata for an app.
ResponseE3Baaa015480_MusicRecording:
properties:
name:
type: string
minLength: 1
title: Name
description: The name of the song or album.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: The rating of the music.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: A thumbnail associated with the music.
type: object
required:
- name
title: MusicRecording
description: Result classified as a music label or a song.
ResponseE3Baaa015480_Recipe:
properties:
title:
type: string
title: Title
description: The title of the recipe.
description:
type: string
title: Description
description: The description of the recipe.
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: A thumbnail associated with the recipe.
url:
type: string
title: Url
description: The URL of the web page where the recipe was found.
domain:
type: string
title: Domain
description: The domain of the web page where the recipe was found.
favicon:
type: string
title: Favicon
description: The URL for the favicon of the web page where the recipe was found.
time:
anyOf:
- type: string
- type: 'null'
title: Time
description: The total time required to cook the recipe.
prep_time:
anyOf:
- type: string
- type: 'null'
title: Prep Time
description: The preparation time for the recipe.
cook_time:
anyOf:
- type: string
- type: 'null'
title: Cook Time
description: The cooking time for the recipe.
ingredients:
anyOf:
- type: string
- type: 'null'
title: Ingredients
description: Ingredients required for the recipe.
instructions:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_HowTo'
type: array
- type: 'null'
title: Instructions
description: List of instructions for the recipe.
servings:
anyOf:
- type: integer
- type: 'null'
title: Servings
description: How many people the recipe serves.
calories:
anyOf:
- type: integer
- type: 'null'
title: Calories
description: Calorie count for the recipe.
publisher:
anyOf:
- type: string
- type: 'null'
title: Publisher
description: The publisher of the recipe.
rating:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Rating
- type: 'null'
description: Aggregated information on the ratings associated with the recipe.
recipeCategory:
anyOf:
- type: string
- type: 'null'
title: Recipecategory
description: The category of the recipe.
recipeCuisine:
anyOf:
- type: string
- type: 'null'
title: Recipecuisine
description: The cuisine classification for the recipe.
video:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__VideoData
- type: 'null'
description: >-
Aggregated information on the cooking video associated with the
recipe.
type: object
required:
- title
- description
- thumbnail
- url
- domain
- favicon
title: Recipe
description: Aggregated information on a recipe.
ResponseE3Baaa015480_Software:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: The name of the software product.
author:
anyOf:
- type: string
- type: 'null'
title: Author
description: The author of software product.
version:
anyOf:
- type: string
- type: 'null'
title: Version
description: The latest version of the software product.
codeRepository:
anyOf:
- type: string
- type: 'null'
title: Coderepository
description: >-
The code repository where the software product is currently
available or maintained.
homepage:
anyOf:
- type: string
- type: 'null'
title: Homepage
description: The home page of the software product.
datePublished:
anyOf:
- type: string
- type: 'null'
title: Datepublished
description: The date when the software product was published.
is_npm:
anyOf:
- type: boolean
- type: 'null'
title: Is Npm
description: Whether the software product is available on npm.
is_pypi:
anyOf:
- type: boolean
- type: 'null'
title: Is Pypi
description: Whether the software product is available on pypi.
stars:
anyOf:
- type: integer
- type: 'null'
title: Stars
description: The number of stars on the repository.
forks:
anyOf:
- type: integer
- type: 'null'
title: Forks
description: The numbers of forks of the repository.
programmingLanguage:
anyOf:
- type: string
- type: 'null'
title: Programminglanguage
description: The programming language spread on the software product.
type: object
title: Software
description: A model representing a software entity.
ResponseE3Baaa015480_Organization:
properties:
type:
type: string
title: Type
description: >-
A type string identifying an organization. The value is always
organization.
default: organization
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.
contact_points:
anyOf:
- items:
$ref: '#/components/schemas/ResponseE3Baaa015480_ContactPoint'
type: array
- type: 'null'
title: Contact Points
description: A list of contact points for the organization.
type: object
required:
- name
title: Organization
description: An entity responsible for another entity.
ResponseE3Baaa015480_PostprocessedIcon:
properties:
href:
type: string
title: Href
sizes:
anyOf:
- type: string
- type: 'null'
title: Sizes
rel:
anyOf:
- type: string
- type: 'null'
title: Rel
type:
anyOf:
- type: string
- type: 'null'
title: Type
ext:
anyOf:
- type: string
- type: 'null'
title: Ext
type: object
required:
- href
- sizes
- rel
- type
- ext
title: PostprocessedIcon
ResponseE3Baaa015480_ForumData:
properties:
forum_name:
type: string
title: Forum Name
description: The name of the forum.
num_answers:
anyOf:
- type: integer
- type: 'null'
title: Num Answers
description: The number of answers to the post.
score:
anyOf:
- type: string
- type: 'null'
title: Score
description: The score of the post on the forum.
title:
anyOf:
- type: string
- type: 'null'
title: Title
description: The title of the post on the forum.
question:
anyOf:
- type: string
- type: 'null'
title: Question
description: The question asked in the forum post.
top_comment:
anyOf:
- type: string
- type: 'null'
title: Top Comment
description: The top-rated comment under the forum post.
type: object
required:
- forum_name
title: ForumData
description: Defines a result from a discussion forum.
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_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_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_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_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_app__models__products__search__v1__videos__VideoData:
properties:
duration:
anyOf:
- type: string
- type: 'null'
title: Duration
description: A time string representing the duration of the video.
views:
anyOf:
- type: integer
- type: 'null'
title: Views
description: The number of views of the video.
creator:
anyOf:
- type: string
- type: 'null'
title: Creator
description: The creator of the video.
publisher:
anyOf:
- type: string
- type: 'null'
title: Publisher
description: The publisher of the video.
requires_subscription:
anyOf:
- type: boolean
- type: 'null'
title: Requires Subscription
description: Whether the video requires a subscription.
tags:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tags
description: A list of tags relevant to the video.
author:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__videos__Profile
- type: 'null'
description: A profile associated with the video.
type: object
title: VideoData
ResponseE3Baaa015480_app__models__products__search__v1__videos__MetaUrl:
properties:
scheme:
anyOf:
- type: string
- type: 'null'
title: Scheme
description: The protocol scheme extracted from the URL.
netloc:
anyOf:
- type: string
- type: 'null'
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:
anyOf:
- type: string
- type: 'null'
title: Favicon
description: The favicon used for the URL.
path:
anyOf:
- type: string
- type: 'null'
title: Path
description: The hierarchical path of the URL useful as a display string.
type: object
title: MetaUrl
ResponseE3Baaa015480_app__models__products__search__v1__videos__Thumbnail:
properties:
src:
type: string
title: Src
description: The served URL of the thumbnail associated with the video.
original:
anyOf:
- type: string
- type: 'null'
title: Original
description: The original URL of the thumbnail associated with the video.
type: object
required:
- src
title: Thumbnail
ResponseE3Baaa015480_SearchAPIVertical:
type: string
enum:
- calculator
- cryptocurrency
- currency
- definitions
- formula1
- packagetracker
- sports
- stocks
- unitconversion
- unixtimestamp
- weather
title: SearchAPIVertical
ResponseE3Baaa015480_ButtonResult:
properties:
type:
type: string
enum:
- button_result
const: button_result
title: Type
description: >-
A type identifying button result. The value is always
button_result.
default: button_result
title:
type: string
title: Title
description: The title of the result.
url:
type: string
title: Url
description: The URL for the button result.
type: object
required:
- title
- url
title: ButtonResult
description: A result which can be used as a button.
ResponseE3Baaa015480_app__models__products__search__v1__shared__VideoResult:
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:
- video_result
const: video_result
title: Type
description: >-
The type identifying the video result. The value is always
video_result.
default: video_result
video:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__VideoData
description: Meta data for the video.
meta_url:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__MetaUrl
- type: 'null'
description: Aggregated information on the URL.
thumbnail:
anyOf:
- $ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
- type: 'null'
description: The thumbnail of the video.
age:
anyOf:
- type: string
- type: 'null'
title: Age
description: >-
A human-readable representation of the video’s age. For example,
2 days ago.
publisher:
anyOf:
- type: string
- type: 'null'
title: Publisher
description: The publisher of the video.
type: object
required:
- title
- url
- video
title: VideoResult
description: A model representing a video result.
ResponseE3Baaa015480_Image:
properties:
thumbnail:
$ref: >-
#/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Thumbnail
description: The thumbnail associated with the image.
url:
anyOf:
- type: string
- type: 'null'
title: Url
description: The URL of the image.
properties:
anyOf:
- $ref: '#/components/schemas/ResponseE3Baaa015480_ImageProperties'
- type: 'null'
description: Metadata on the image.
type: object
required:
- thumbnail
title: Image
description: A model describing an image.
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.
ResponseE3Baaa015480_Answer:
properties:
text:
type: string
title: Text
description: The main content of the answer.
author:
anyOf:
- type: string
- type: 'null'
title: Author
description: The name of the author of the answer.
upvoteCount:
anyOf:
- type: integer
- type: 'null'
title: Upvotecount
description: Number of upvotes on the answer.
downvoteCount:
anyOf:
- type: integer
- type: 'null'
title: Downvotecount
description: The number of downvotes on the answer.
type: object
required:
- text
title: Answer
description: A response representing an answer to a question on a forum.
ResponseE3Baaa015480_Price:
properties:
price:
type: string
title: Price
description: The price value in a given currency.
priceCurrency:
type: string
title: Pricecurrency
description: The currency of the price value.
type: object
required:
- price
- priceCurrency
title: Price
description: A model representing the price for an entity.
ResponseE3Baaa015480_app__models__products__search__v1__shared__Offer:
properties:
url:
type: string
title: Url
description: The URL where the offer can be found.
priceCurrency:
type: string
title: Pricecurrency
description: The currency in which the offer is made.
price:
type: string
title: Price
description: The price of the product currently on offer.
type: object
required:
- url
- priceCurrency
- price
title: Offer
description: An offer associated with a product.
ResponseE3Baaa015480_HowTo:
properties:
text:
type: string
title: Text
description: The how to text.
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: A name for the how to.
url:
anyOf:
- type: string
- type: 'null'
title: Url
description: A URL associated with the how to.
image:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Image
description: A list of image URLs associated with the how to.
type: object
required:
- text
title: HowTo
description: Aggregated information on a how to.
ResponseE3Baaa015480_ContactPoint:
properties:
type:
type: string
title: Type
description: >-
A type string identifying a contact point. The value is always
contact_point.
default: contact_point
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.
telephone:
anyOf:
- type: string
- type: 'null'
title: Telephone
description: The telephone number of the entity.
email:
anyOf:
- type: string
- type: 'null'
title: Email
description: The email address of the entity.
type: object
required:
- name
title: ContactPoint
description: A way to contact an entity.
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__videos__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
ResponseE3Baaa015480_ImageProperties:
properties:
url:
type: string
title: Url
description: The original image URL.
resized:
type: string
title: Resized
description: The URL for a better quality resized image.
placeholder:
type: string
title: Placeholder
description: The placeholder image URL.
height:
anyOf:
- type: integer
- type: 'null'
title: Height
description: The image height.
width:
anyOf:
- type: integer
- type: 'null'
title: Width
description: The image width.
format:
anyOf:
- type: string
- type: 'null'
title: Format
description: The image format.
content_size:
anyOf:
- type: string
- type: 'null'
title: Content Size
description: The image size.
type: object
required:
- url
- resized
- placeholder
title: ImageProperties
description: Metadata on an image.
securitySchemes:
bearerAuth:
scheme: bearer
type: http
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.