> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative. > - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key. > - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste. > - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`. > - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt # Web Search > Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. ## Request contract * **Method and path:** GET /apis/v1/brave/web/search * **Availability:** enabled * **Request URL template:** [https://api.aisa.one/apis/v1/brave/web/search](https://api.aisa.one/apis/v1/brave/web/search) * **accept:** header; optional * **api-version:** header; optional * **cache-control:** header; optional * **user-agent:** header; optional * **x-loc-city:** header; optional * **x-loc-country:** header; optional * **x-loc-lat:** header; optional * **x-loc-long:** header; optional * **x-loc-postal-code:** header; optional * **x-loc-state:** header; optional * **x-loc-state-name:** header; optional * **x-loc-timezone:** header; optional * **count:** query; optional * **country:** query; optional * **enable\_rich\_callback:** query; optional * **extra\_snippets:** query; optional * **freshness:** query; optional * **goggles:** query; optional * **goggles\_id:** query; optional * **include\_fetch\_metadata:** query; optional * **offset:** query; optional * **operators:** query; optional * **q:** query; required * **result\_filter:** query; optional * **safesearch:** query; optional * **search\_lang:** query; optional * **spellcheck:** query; optional * **summary:** query; optional * **text\_decorations:** query; optional * **ui\_lang:** query; optional * **units:** query; optional * **Runtime facts:** 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc [Complete OpenAPI definition](https://aisa.one/docs/openapi/brave-search.json) Effective request and pricing declaration (including authentication and referenced schemas): ```json theme={null} { "operationId": "get_any_brave_search_apis_v1_brave_web_search", "method": "GET", "path": "/apis/v1/brave/web/search", "servers": [ { "url": "https://api.aisa.one" } ], "parameters": [ { "deprecated": false, "description": "The default supported media type is application/json.", "examples": { "0": { "value": "application/json" } }, "in": "header", "name": "accept", "required": false, "schema": { "allOf": [ { "enum": [ "application/json", "*/*" ], "title": "Accept", "type": "string" }, { "default": "application/json" } ], "description": "The default supported media type is application/json.", "examples": [ "application/json" ], "title": "Media type" } }, { "deprecated": false, "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.", "in": "header", "name": "api-version", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "title": "API version" } }, { "deprecated": 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.", "in": "header", "name": "cache-control", "required": false, "schema": { "anyOf": [ { "const": "no-cache", "enum": [ "no-cache" ], "title": "CacheControl", "type": "string" }, { "type": "null" } ], "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.", "title": "Cache control" } }, { "deprecated": 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.", "examples": { "Android": { "description": "Android", "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36" }, "Windows": { "description": "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" }, "iOS": { "description": "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" }, "macOS": { "description": "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" } }, "in": "header", "name": "user-agent", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "title": "User agent" } }, { "deprecated": false, "description": "The generic name of the client city.", "examples": { "City in USA": { "value": "San Francisco" } }, "in": "header", "name": "x-loc-city", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The generic name of the client city.", "title": "City" } }, { "deprecated": false, "description": "

The two letter country code for the client’s country.\nFor a list of country codes, see ISO 3166-1 alpha-2.

", "examples": { "0": { "value": "US" } }, "in": "header", "name": "x-loc-country", "required": false, "schema": { "anyOf": [ { "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": "string" }, { "type": "null" } ], "description": "

The two letter country code for the client’s country.\nFor a list of country codes, see ISO 3166-1 alpha-2.

", "examples": [ "US" ], "title": "Country code" } }, { "deprecated": 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.", "examples": { "0": { "value": 37.787 } }, "in": "header", "name": "x-loc-lat", "required": false, "schema": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "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 ], "title": "Latitude" } }, { "deprecated": 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.", "examples": { "0": { "value": -122.4 } }, "in": "header", "name": "x-loc-long", "required": false, "schema": { "anyOf": [ { "maximum": 180, "minimum": -180, "type": "number" }, { "type": "null" } ], "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 ], "title": "Longitude" } }, { "deprecated": false, "description": "The client’s postal code.", "examples": { "Postal code in San Francisco, California, US": { "value": "94105" } }, "in": "header", "name": "x-loc-postal-code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client’s postal code.", "title": "Postal code" } }, { "deprecated": 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.", "examples": { "0": { "value": "CA" } }, "in": "header", "name": "x-loc-state", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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" ], "title": "State/Region code" } }, { "deprecated": 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.", "examples": { "0": { "value": "California" } }, "in": "header", "name": "x-loc-state-name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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" ], "title": "State/Region name" } }, { "deprecated": 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.", "examples": { "IANA timezone for San Francisco in USA": { "value": "America/San_Francisco" } }, "in": "header", "name": "x-loc-timezone", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database.", "title": "IANA timezone" } }, { "deprecated": false, "description": "

The number of search results returned in response.\nThe maximum is 20. The actual number delivered may be less than requested.\nCombine this parameter with offset to paginate search results.

\n

NOTE: Count only applies to web results.

", "in": "query", "name": "count", "required": false, "schema": { "default": 20, "description": "

The number of search results returned in response.\nThe maximum is 20. The actual number delivered may be less than requested.\nCombine this parameter with offset to paginate search results.

\n

NOTE: Count only applies to web results.

", "maximum": 20, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "The 2 character country code where the search results come from.", "in": "query", "name": "country", "required": false, "schema": { "allOf": [ { "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", "type": "string" }, { "default": "US" } ], "description": "The 2 character country code where the search results come from.", "title": "Search country" } }, { "deprecated": false, "description": "

Enable rich callback.\nAllows you to get real time rich results via a callback URL when they are relevant to your query.

\n

NOTE: Requires Search plan.

", "examples": { "0": { "value": "" }, "1": { "value": false }, "2": { "value": true } }, "in": "query", "name": "enable_rich_callback", "required": false, "schema": { "default": false, "description": "

Enable rich callback.\nAllows you to get real time rich results via a callback URL when they are relevant to your query.

\n

NOTE: Requires Search plan.

", "examples": [ "", false, true ], "title": "Enable Rich Callback", "type": "boolean" } }, { "deprecated": false, "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "extra_snippets", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.", "examples": [ "", true, false ], "title": "Extra snippets" } }, { "deprecated": false, "description": "

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:

\n", "examples": { "0": { "value": "" }, "1": { "value": "pm" }, "2": { "value": "2022-04-01to2022-07-30" } }, "in": "query", "name": "freshness", "required": false, "schema": { "default": "", "description": "

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:

\n", "examples": [ "", "pm", "2022-04-01to2022-07-30" ], "title": "Freshness", "type": "string" } }, { "deprecated": false, "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "examples": { "": { "value": "" }, "Prioritizes domains popular with the Hacker News": { "value": "https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle" }, "Social media blocker": { "value": "! name: Social Networks\n! description: Removes social networks\n! public: true\n! author: Average Joe\n! avatar: #de0320\n\n$discard,site=facebook.com\n$discard,site=x.com\n$discard,site=instagram.com" } }, "in": "query", "name": "goggles", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles.", "title": "Goggles" } }, { "deprecated": true, "description": "Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.", "examples": { "": { "value": "" }, "Prioritizes domains popular with the Hacker News": { "value": "https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle" } }, "in": "query", "name": "goggles_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.", "title": "Goggles id" } }, { "deprecated": false, "description": "Include fetch metadata.", "examples": { "0": { "value": "" }, "1": { "value": false }, "2": { "value": true } }, "in": "query", "name": "include_fetch_metadata", "required": false, "schema": { "default": false, "description": "Include fetch metadata.", "examples": [ "", false, true ], "title": "Include Fetch Metadata", "type": "boolean" } }, { "deprecated": false, "description": "

The zero based offset that indicates number of search\nresult pages (count) to skip before returning the result.\nThe default is 0 and the maximum is 9.\nThe actual number delivered may be less than requested.

\n

Use this parameter along with the count parameter to page results.\nFor example, if your user interface displays 10 search results per page,\nset count to 10 and offset to 0 to get the first page of results.\nFor each subsequent page, increment offset by 1 (for example, 0, 1, 2).\nIt is possible for multiple pages to include some overlap in results.

", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "

The zero based offset that indicates number of search\nresult pages (count) to skip before returning the result.\nThe default is 0 and the maximum is 9.\nThe actual number delivered may be less than requested.

\n

Use this parameter along with the count parameter to page results.\nFor example, if your user interface displays 10 search results per page,\nset count to 10 and offset to 0 to get the first page of results.\nFor each subsequent page, increment offset by 1 (for example, 0, 1, 2).\nIt is possible for multiple pages to include some overlap in results.

", "maximum": 9, "minimum": 0, "title": "Offset", "type": "integer" } }, { "deprecated": false, "description": "Whether to apply search operators", "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "operators", "required": false, "schema": { "default": true, "description": "Whether to apply search operators", "examples": [ "", true, false ], "title": "Operators", "type": "boolean" } }, { "deprecated": false, "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "examples": { "default": { "value": "brave search" } }, "in": "query", "name": "q", "required": true, "schema": { "description": "The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "maxLength": 600, "minLength": 1, "title": "Query", "type": "string" } }, { "deprecated": false, "description": "

A comma delimited string of result types to include in the search response.\nNot specifying this parameter will return back all result types in search response where data is available\nand the plan has the corresponding option activated. The response always includes query and type to\nidentify any query modifications and response type respectively.\nAvailable result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

\n

NOTE: count param only applies to web results.

", "examples": { "0": { "value": "" }, "1": { "value": "web" }, "2": { "value": "videos" }, "3": { "value": "web,videos" } }, "in": "query", "name": "result_filter", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "description": "

A comma delimited string of result types to include in the search response.\nNot specifying this parameter will return back all result types in search response where data is available\nand the plan has the corresponding option activated. The response always includes query and type to\nidentify any query modifications and response type respectively.\nAvailable result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

\n

NOTE: count param only applies to web results.

", "examples": [ "", "web", "videos", "web,videos" ], "title": "Result filter" } }, { "deprecated": false, "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": { "0": { "value": "" }, "1": { "value": "off" }, "2": { "value": "moderate" }, "3": { "value": "strict" } }, "in": "query", "name": "safesearch", "required": false, "schema": { "allOf": [ { "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch", "type": "string" }, { "default": "moderate" } ], "description": "

Filters search results for adult content. The following values are supported:

\n", "examples": [ "", "off", "moderate", "strict" ], "title": "Safe search" } }, { "deprecated": false, "description": "The 2 or more character language code for which the search results are provided.", "in": "query", "name": "search_lang", "required": false, "schema": { "allOf": [ { "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", "type": "string" }, { "default": "en" } ], "description": "The 2 or more character language code for which the search results are provided.", "title": "Search language" } }, { "deprecated": false, "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "spellcheck", "required": false, "schema": { "default": true, "description": "Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.", "examples": [ "", true, false ], "title": "Spellcheck", "type": "boolean" } }, { "deprecated": false, "description": "This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.", "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "summary", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.", "examples": [ "", true, false ], "title": "Summary" } }, { "deprecated": false, "description": "Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).", "examples": { "0": { "value": "" }, "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "text_decorations", "required": false, "schema": { "default": true, "description": "Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).", "examples": [ "", true, false ], "title": "Text decorations", "type": "boolean" } }, { "deprecated": false, "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "in": "query", "name": "ui_lang", "required": false, "schema": { "allOf": [ { "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", "type": "string" }, { "default": "en-US" } ], "description": "User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.", "title": "User interface language" } }, { "deprecated": false, "description": "

The measurement units. The following values are supported:

\n", "examples": { "0": { "value": "" }, "1": { "value": "metric" }, "2": { "value": "imperial" } }, "in": "query", "name": "units", "required": false, "schema": { "anyOf": [ { "enum": [ "imperial", "metric" ], "title": "MeasurementUnit", "type": "string" }, { "type": "null" } ], "description": "

The measurement units. The following values are supported:

\n", "examples": [ "", "metric", "imperial" ], "title": "Units" } } ], "security": [ { "bearerAuth": [] } ], "x-aisa-status": "enabled", "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } } } ``` ## Cost and request rules Published reference price: \$0.005 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar. * **Default request reference estimate (USD):** 0.005 * **Cost contract:** fixed\_success * **Published reference multiplier:** 1.0 * **Settlement evidence source:** request\_snapshot ## OpenAPI ````yaml openapi/brave-search.json GET /apis/v1/brave/web/search openapi: 3.1.0 info: description: '' title: Brave Search version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-catalogs: brave-search: description: '' title: Brave Search x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-document: facts_hash: 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc generator_version: '3' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-configured-paths: - /apis/v1/brave/images/search - /apis/v1/brave/llm/context - /apis/v1/brave/local/descriptions - /apis/v1/brave/local/place_search - /apis/v1/brave/local/pois - /apis/v1/brave/news/search - /apis/v1/brave/spellcheck/search - /apis/v1/brave/suggest/search - /apis/v1/brave/videos/search - /apis/v1/brave/web/rich - /apis/v1/brave/web/search x-aisa-document: composer_version: '20' document_hash: sha256:dd3bf51bf816c65187edaf986eabe02a048ea79407f7f5e64e18c08fd29983cf facts_hash: 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc generator_version: '3' protocol_version: '1' response_pending: [] schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: brave-search servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/brave/web/search: get: tags: - default summary: Web Search description: >- Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. operationId: get_any_brave_search_apis_v1_brave_web_search parameters: - deprecated: false description: The default supported media type is application/json. examples: '0': value: application/json in: header name: accept required: false schema: allOf: - enum: - application/json - '*/*' title: Accept type: string - default: application/json description: The default supported media type is application/json. examples: - application/json title: Media type - deprecated: false 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. in: header name: api-version required: false schema: anyOf: - type: string - type: 'null' 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. title: API version - deprecated: 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. in: header name: cache-control required: false schema: anyOf: - const: no-cache enum: - no-cache title: CacheControl type: string - type: 'null' 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. title: Cache control - deprecated: 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. examples: Android: description: Android value: >- Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36 Windows: description: 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 iOS: description: 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 macOS: description: 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 in: header name: user-agent required: false schema: anyOf: - type: string - type: 'null' 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. title: User agent - deprecated: false description: The generic name of the client city. examples: City in USA: value: San Francisco in: header name: x-loc-city required: false schema: anyOf: - type: string - type: 'null' description: The generic name of the client city. title: City - deprecated: false description: >-

The two letter country code for the client’s country. For a list of country codes, see ISO 3166-1 alpha-2.

examples: '0': value: US in: header name: x-loc-country required: false schema: anyOf: - 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: string - type: 'null' 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 title: Country code - deprecated: 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. examples: '0': value: 37.787 in: header name: x-loc-lat required: false schema: anyOf: - maximum: 90 minimum: -90 type: number - type: 'null' 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 title: Latitude - deprecated: 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. examples: '0': value: -122.4 in: header name: x-loc-long required: false schema: anyOf: - maximum: 180 minimum: -180 type: number - type: 'null' 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 title: Longitude - deprecated: false description: The client’s postal code. examples: Postal code in San Francisco, California, US: value: '94105' in: header name: x-loc-postal-code required: false schema: anyOf: - type: string - type: 'null' description: The client’s postal code. title: Postal code - deprecated: 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. examples: '0': value: CA in: header name: x-loc-state required: false schema: anyOf: - type: string - type: 'null' 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 title: State/Region code - deprecated: 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. examples: '0': value: California in: header name: x-loc-state-name required: false schema: anyOf: - type: string - type: 'null' 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 title: State/Region name - deprecated: 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. examples: IANA timezone for San Francisco in USA: value: America/San_Francisco in: header name: x-loc-timezone required: false schema: anyOf: - type: string - type: 'null' description: >- The IANA timezone for the client’s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database. title: IANA timezone - deprecated: false 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.

in: query name: count required: false schema: default: 20 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.

maximum: 20 minimum: 1 title: Count type: integer - deprecated: false description: The 2 character country code where the search results come from. in: query name: country required: false schema: allOf: - 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 type: string - default: US description: The 2 character country code where the search results come from. title: Search country - deprecated: false description: >-

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.

examples: '0': value: '' '1': value: false '2': value: true in: query name: enable_rich_callback required: false schema: default: false description: >-

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.

examples: - '' - false - true title: Enable Rich Callback type: boolean - deprecated: false description: >- A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. examples: '0': value: '' '1': value: true '2': value: false in: query name: extra_snippets required: false schema: anyOf: - type: boolean - type: 'null' description: >- A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. examples: - '' - true - false title: Extra snippets - deprecated: false description: >-

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:

examples: '0': value: '' '1': value: pm '2': value: 2022-04-01to2022-07-30 in: query name: freshness required: false schema: default: '' description: >-

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:

examples: - '' - pm - 2022-04-01to2022-07-30 title: Freshness type: string - deprecated: false description: >- Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles. examples: '': value: '' Prioritizes domains popular with the Hacker News: value: >- https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle Social media blocker: value: |- ! name: Social Networks ! description: Removes social networks ! public: true ! author: Average Joe ! avatar: #de0320 $discard,site=facebook.com $discard,site=x.com $discard,site=instagram.com in: query name: goggles required: false schema: anyOf: - type: string - items: type: string type: array - type: 'null' description: >- Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles. title: Goggles - deprecated: true description: >- Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter. examples: '': value: '' Prioritizes domains popular with the Hacker News: value: >- https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle in: query name: goggles_id required: false schema: anyOf: - type: string - type: 'null' description: >- Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter. title: Goggles id - deprecated: false description: Include fetch metadata. examples: '0': value: '' '1': value: false '2': value: true in: query name: include_fetch_metadata required: false schema: default: false description: Include fetch metadata. examples: - '' - false - true title: Include Fetch Metadata type: boolean - deprecated: false 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.

in: query name: offset required: false schema: default: 0 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.

maximum: 9 minimum: 0 title: Offset type: integer - deprecated: false description: Whether to apply search operators examples: '0': value: '' '1': value: true '2': value: false in: query name: operators required: false schema: default: true description: Whether to apply search operators examples: - '' - true - false title: Operators type: boolean - deprecated: false description: >- The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query. examples: default: value: brave search in: query name: q required: true schema: description: >- The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query. maxLength: 600 minLength: 1 title: Query type: string - deprecated: false description: >-

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: '0': value: '' '1': value: web '2': value: videos '3': value: web,videos in: query name: result_filter required: false schema: anyOf: - items: type: string type: array uniqueItems: true - type: 'null' description: >-

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 title: Result filter - deprecated: false description: >-

Filters search results for adult content. The following values are supported:

examples: '0': value: '' '1': value: 'off' '2': value: moderate '3': value: strict in: query name: safesearch required: false schema: allOf: - enum: - 'off' - moderate - strict title: SafeSearch type: string - default: moderate description: >-

Filters search results for adult content. The following values are supported:

examples: - '' - 'off' - moderate - strict title: Safe search - deprecated: false description: >- The 2 or more character language code for which the search results are provided. in: query name: search_lang required: false schema: allOf: - 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 type: string - default: en description: >- The 2 or more character language code for which the search results are provided. title: Search language - deprecated: false description: >- Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model. examples: '0': value: '' '1': value: true '2': value: false in: query name: spellcheck required: false schema: default: true description: >- Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model. examples: - '' - true - false title: Spellcheck type: boolean - deprecated: false description: >- This parameter enables summary key generation in web search results. This is required for summarizer to be enabled. examples: '0': value: '' '1': value: true '2': value: false in: query name: summary required: false schema: anyOf: - type: boolean - type: 'null' description: >- This parameter enables summary key generation in web search results. This is required for summarizer to be enabled. examples: - '' - true - false title: Summary - deprecated: false description: >- Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters). examples: '0': value: '' '1': value: true '2': value: false in: query name: text_decorations required: false schema: default: true description: >- Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters). examples: - '' - true - false title: Text decorations type: boolean - deprecated: false description: >- User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110. in: query name: ui_lang required: false schema: allOf: - 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 type: string - default: en-US description: >- User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110. title: User interface language - deprecated: false description: >-

The measurement units. The following values are supported:

examples: '0': value: '' '1': value: metric '2': value: imperial in: query name: units required: false schema: anyOf: - enum: - imperial - metric title: MeasurementUnit type: string - type: 'null' description: >-

The measurement units. The following values are supported:

examples: - '' - metric - imperial title: Units responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResponseB91D37C29Ffe_WebSearchApiResponse' description: Successful Response default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats x-codeSamples: - label: Reference example lang: text source: >- # Fixed reference example. Playground inputs do not update this sample. curl --request GET \ --url 'https://api.aisa.one/apis/v1/brave/web/search?q=brave+search' \ --header 'Authorization: Bearer ' components: schemas: ResponseB91D37C29Ffe_WebSearchApiResponse: properties: discussions: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Discussions' - type: 'null' description: >- Discussions clusters aggregated from forum posts that are relevant to the query. faq: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__faq__FAQ - type: 'null' description: Frequently asked questions that are relevant to the search query. infobox: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_GraphInfobox' - type: 'null' description: Aggregated information on an entity showable as an infobox. locations: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Locations' - type: 'null' description: Places of interest (POIs) relevant to location sensitive queries. mixed: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MixedResponse' - type: 'null' description: Preferred ranked order of search results. news: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_News' - type: 'null' description: News results relevant to the query. query: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__query__Query - type: 'null' description: Search query string and its modifications that are used for search. rich: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_RichHeaderCallback' - type: 'null' description: Callback information to retrieve rich results. summarizer: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Summarizer' - type: 'null' description: Summary key to get summary results for the query. type: const: search default: search enum: - search title: Type type: string videos: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Videos' - type: 'null' description: Videos results relevant to the query. web: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Search' - type: 'null' description: Web results relevant to the query. title: WebSearchApiResponse type: object ResponseB91D37C29Ffe_Discussions: description: A model representing a discussion cluster relevant to the query. properties: mutated_by_goggles: default: false description: >- Whether the discussion results are changed by Goggles. The value is false by default. title: Mutated By Goggles type: boolean results: description: A list of discussion results. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_DiscussionResult' title: Results type: array type: const: search default: search description: >- The type identifying a discussion cluster. Currently the value is always search. enum: - search title: Type type: string required: - results title: Discussions type: object ResponseB91D37C29Ffe_app__models__products__search__v1__faq__FAQ: description: Frequently asked questions relevant to the search query term. properties: results: description: A list of aggregated question answer results relevant to the query. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_QA' title: Results type: array type: const: faq default: faq description: >- The FAQ result type identifier. The value is always faq. enum: - faq title: Type type: string required: - results title: FAQ type: object ResponseB91D37C29Ffe_GraphInfobox: description: Aggregated information on an entity shown as an infobox. properties: results: description: A list of infoboxes associated with the query. items: discriminator: mapping: code: '#/components/schemas/ResponseB91D37C29Ffe_QAInfobox' entity: '#/components/schemas/ResponseB91D37C29Ffe_EntityInfobox' generic: '#/components/schemas/ResponseB91D37C29Ffe_GenericInfobox' location: '#/components/schemas/ResponseB91D37C29Ffe_InfoboxWithLocation' place: '#/components/schemas/ResponseB91D37C29Ffe_InfoboxPlace' propertyName: subtype oneOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_GenericInfobox' - $ref: '#/components/schemas/ResponseB91D37C29Ffe_QAInfobox' - $ref: '#/components/schemas/ResponseB91D37C29Ffe_InfoboxPlace' - $ref: '#/components/schemas/ResponseB91D37C29Ffe_InfoboxWithLocation' - $ref: '#/components/schemas/ResponseB91D37C29Ffe_EntityInfobox' title: Results type: array type: const: graph default: graph description: >- The type identifier for infoboxes. The value is always graph. enum: - graph title: Type type: string required: - results title: GraphInfobox type: object ResponseB91D37C29Ffe_Locations: description: A model representing location results. properties: provider: anyOf: - type: object - type: 'null' description: The provider of the location data. title: Provider results: description: An aggregated list of location sensitive results. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' title: Results type: array type: const: locations default: locations description: >- Location type identifier. The value is always locations. enum: - locations title: Type type: string required: - results title: Locations type: object ResponseB91D37C29Ffe_MixedResponse: description: The ranking order of results on a search result page. properties: main: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_ResultReference' type: array - type: 'null' description: The ranking order for the main section of the search result page. title: Main side: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_ResultReference' type: array - type: 'null' description: The ranking order for the side section of the search result page. title: Side top: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_ResultReference' type: array - type: 'null' description: The ranking order for the top section of the search result page. title: Top type: const: mixed default: mixed description: >- The type representing the model mixed. The value is always mixed. enum: - mixed title: Type type: string title: MixedResponse type: object ResponseB91D37C29Ffe_News: properties: mutated_by_goggles: default: false description: Whether the results are mutated by a goggle. title: Mutated By Goggles type: boolean results: description: The list of news results. items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__NewsResult title: Results type: array type: const: news default: news description: The type of API result. The value is always news. enum: - news title: Type type: string required: - results title: News type: object ResponseB91D37C29Ffe_app__models__products__search__v1__query__Query: properties: altered: anyOf: - type: string - type: 'null' description: The altered query by the spellchecker. title: Altered ask_for_location: anyOf: - type: boolean - type: 'null' description: Whether to prompt the user for their location. title: Ask For Location bad_results: anyOf: - type: boolean - type: 'null' description: Whether the results are considered low quality. title: Bad Results city: anyOf: - type: string - type: 'null' description: The city for location-based queries. title: City cleaned: anyOf: - type: string - type: 'null' description: The cleaned normalized query. title: Cleaned country: anyOf: - type: string - type: 'null' description: The country code for the query. title: Country custom_location_label: anyOf: - type: string - type: 'null' description: A custom label for the location. title: Custom Location Label header_country: anyOf: - type: string - type: 'null' description: The country from request headers. title: Header Country is_geolocal: anyOf: - type: boolean - type: 'null' description: Whether the query has local intent. title: Is Geolocal is_navigational: anyOf: - type: boolean - type: 'null' description: >- Whether the query is navigational (user wants to go to a specific site). title: Is Navigational is_news_breaking: anyOf: - type: boolean - type: 'null' description: Whether the query is related to breaking news. title: Is News Breaking is_trending: anyOf: - type: boolean - type: 'null' description: Whether the query is a trending topic. title: Is Trending language: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__language__Language - type: 'null' description: The detected language of the query. lat: anyOf: - type: string - type: 'null' description: The latitude for location-based queries. title: Lat local_decision: anyOf: - type: string - type: 'null' description: The local search decision for the query. title: Local Decision local_locations_idx: anyOf: - type: integer - type: 'null' description: Index of the local location result. title: Local Locations Idx long: anyOf: - type: string - type: 'null' description: The longitude for location-based queries. title: Long more_results_available: anyOf: - type: boolean - type: 'null' description: Whether more results are available for pagination. title: More Results Available original: description: The original query that was requested. title: Original type: string postal_code: anyOf: - type: string - type: 'null' description: The postal code for location-based queries. title: Postal Code reddit_cluster: anyOf: - type: string - type: 'null' description: Reddit cluster identifier for discussion results. title: Reddit Cluster related_queries: default: [] description: Related queries for the query. items: type: string title: Related Queries type: array safesearch: anyOf: - type: boolean - type: 'null' description: Whether safesearch is active. title: Safesearch search_operators: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_SearchOperators' - type: 'null' description: Search operators that were detected and applied to the query. should_fallback: anyOf: - type: boolean - type: 'null' description: Whether to fallback to alternative ranking. title: Should Fallback show_strict_warning: anyOf: - type: boolean - type: 'null' description: Whether to show a warning that strict safesearch filtered results. title: Show Strict Warning spellcheck_off: anyOf: - type: boolean - type: 'null' description: Whether spellcheck is disabled for this query. title: Spellcheck Off state: anyOf: - type: string - type: 'null' description: The state/region for location-based queries. title: State summary_key: anyOf: - type: string - type: 'null' description: Key to retrieve AI-generated summary for the query. title: Summary Key required: - original title: Query type: object ResponseB91D37C29Ffe_RichHeaderCallback: properties: hint: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_ResponseCallback' - type: 'null' type: const: rich default: rich enum: - rich title: Type type: string title: RichHeaderCallback type: object ResponseB91D37C29Ffe_Summarizer: properties: key: description: The key to retrieve the full summary results. title: Key type: string type: const: summarizer default: summarizer description: The type of result. The value is always summarizer. enum: - summarizer title: Type type: string required: - key title: Summarizer type: object ResponseB91D37C29Ffe_Videos: properties: mutated_by_goggles: default: false description: Whether the results are mutated by a goggle. title: Mutated By Goggles type: boolean results: description: The list of video results. items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoResult title: Results type: array type: const: videos default: videos description: The type of API result. The value is always videos. enum: - videos title: Type type: string required: - results title: Videos type: object ResponseB91D37C29Ffe_Search: description: A model representing a collection of web search results. properties: family_friendly: default: true description: Whether the results are family friendly. title: Family Friendly type: boolean results: description: A list of search results. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_SearchResult' title: Results type: array type: const: search default: search description: >- A type identifying web search results. The value is always search. enum: - search title: Type type: string required: - results title: Search type: object ResponseB91D37C29Ffe_DiscussionResult: description: >- A discussion result. These are forum posts and discussions that are relevant to the search query. properties: age: anyOf: - type: string - type: 'null' description: >- A human-readable representation of the web search result’s age. For example, 2 days ago. title: Age article: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Article' - type: 'null' description: An article found for the web search result page. book: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Book' - type: 'null' description: Any book information associated with the web search result page. cluster: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Result' type: array - type: 'null' description: A list of web search results. title: Cluster cluster_type: anyOf: - type: string - type: 'null' description: A type representing a cluster. The value can be product_cluster. title: Cluster Type content_type: anyOf: - type: string - type: 'null' description: The content type associated with the search result page. title: Content Type creative_work: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_CreativeWork' - type: 'null' description: >- Aggregated information on the creative work found on the web search result. data: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_ForumData' - type: 'null' description: The enriched aggregated data for the relevant forum post. deep_results: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_DeepResult' - type: 'null' description: Gathered information on a web search result. description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description extra_snippets: anyOf: - items: type: string type: array - type: 'null' description: A list of extra alternate snippets for the web search result. title: Extra Snippets family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean faq: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__FAQ - type: 'null' description: >- Any frequently asked questions associated with the web search result. fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp icons: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon' type: array - type: 'null' description: Icons associated with the search result. title: Icons is_live: default: false description: >- Whether the web search result is currently live. Default value is false. title: Is Live type: boolean is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: default: en description: The main language on the web search result. title: Language type: string location: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' - type: 'null' description: The location details if the query relates to a restaurant. meta_url: anyOf: - type: object - type: 'null' description: >- Aggregated information on the URL associated with the web search result. title: Meta Url movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: The movie associated with the web search result. music_recording: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MusicRecording' - type: 'null' description: >- Aggregated information on music recording found on the web search result. organization: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Organization' - type: 'null' description: >- Aggregated information on a organization found on the web search result page. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched product: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Review' - type: 'null' description: >- The main product and a review that is found on the web search result page. title: Product product_cluster: anyOf: - items: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Review' type: array - type: 'null' description: >- A list of products and reviews that are found on the web search result page. title: Product Cluster profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. qa: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_QAPage' - type: 'null' description: >- Any question answer information associated with the web search result page. rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: Rating found for the web search result page. recipe: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Recipe' - type: 'null' description: >- Aggregated information on a recipe found on the web search result page. restaurant: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' - type: 'null' deprecated: true description: Deprecated. Use location instead. review: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Review' - type: 'null' description: Aggregated information on the review found on the web search result. schemas: anyOf: - items: {} type: array - type: 'null' 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. title: Schemas software: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Software' - type: 'null' description: >- Aggregated information on a software product found on the web search result page. subtype: default: generic description: A sub type identifying the web search result type. title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail of the web search result. title: description: The title of the web page. title: Title type: string type: const: discussion default: discussion description: >- The discussion result type identifier. The value is always discussion. enum: - discussion title: Type type: string url: description: The URL where the page is served. title: Url type: string video: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData - type: 'null' description: The video associated with the web search result. required: - title - url title: DiscussionResult type: object ResponseB91D37C29Ffe_QA: description: A question/answer result. properties: answer: description: The answer to the question. title: Answer type: string meta_url: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl - type: 'null' description: Aggregated information about the URL. question: description: The question being asked. title: Question type: string title: description: The title of the post. title: Title type: string url: description: The URL pointing to the post. title: Url type: string required: - question - answer - title - url title: QA type: object ResponseB91D37C29Ffe_QAInfobox: description: A question answer infobox. properties: attributes: default: [] description: A list of attributes about the entity. items: items: anyOf: - type: string - type: 'null' maxItems: 2 minItems: 2 type: array title: Attributes type: array category: anyOf: - type: string - type: 'null' description: Category classification for the entity. title: Category data: $ref: '#/components/schemas/ResponseB91D37C29Ffe_QAPage' description: The question and relevant answer. description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: A unit representing quantity relevant to the entity. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp images: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail type: array - type: 'null' description: A list of images relevant to the entity. title: Images is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean label: anyOf: - type: string - type: 'null' description: Any label associated with the entity. title: Label language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language long_desc: anyOf: - type: string - type: 'null' description: A longer description for the entity. title: Long Desc meta_url: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl - type: 'null' description: >- Detailed information on the page containing the question and relevant answer. movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: >- Any movie data relevant to the entity. Appears only when the result is a movie. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched position: description: The position on a search result page. title: Position type: integer profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile type: array - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: The profiles associated with the entity. title: Profiles providers: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: A list of data sources for the entity. title: Providers ratings: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating type: array - type: 'null' description: Any ratings given to the entity. title: Ratings subtype: const: code default: code description: >- The infobox subtype identifier. The value is always code. enum: - code title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the entity. title: description: The title of the web page. title: Title type: string type: const: infobox default: infobox description: >- The infobox result type identifier. The value is always infobox. enum: - infobox title: Type type: string url: description: The URL where the page is served. title: Url type: string website_url: anyOf: - type: string - type: 'null' description: The official website pertaining to the entity. title: Website Url required: - title - url - position - data title: QAInfobox type: object ResponseB91D37C29Ffe_EntityInfobox: description: Aggregated information on an entity from a knowledge graph. properties: attributes: default: [] description: A list of attributes about the entity. items: items: anyOf: - type: string - type: 'null' maxItems: 2 minItems: 2 type: array title: Attributes type: array category: anyOf: - type: string - type: 'null' description: Category classification for the entity. title: Category description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: A unit representing quantity relevant to the entity. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp images: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail type: array - type: 'null' description: A list of images relevant to the entity. title: Images is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean label: anyOf: - type: string - type: 'null' description: Any label associated with the entity. title: Label language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language long_desc: anyOf: - type: string - type: 'null' description: A longer description for the entity. title: Long Desc movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: >- Any movie data relevant to the entity. Appears only when the result is a movie. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched position: description: The position on a search result page. title: Position type: integer profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile type: array - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: The profiles associated with the entity. title: Profiles providers: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: A list of data sources for the entity. title: Providers ratings: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating type: array - type: 'null' description: Any ratings given to the entity. title: Ratings subtype: const: entity default: entity description: >- The infobox subtype identifier. The value is always entity. enum: - entity title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the entity. title: description: The title of the web page. title: Title type: string type: const: infobox default: infobox description: >- The infobox result type identifier. The value is always infobox. enum: - infobox title: Type type: string url: description: The URL where the page is served. title: Url type: string website_url: anyOf: - type: string - type: 'null' description: The official website pertaining to the entity. title: Website Url required: - title - url - position title: EntityInfobox type: object ResponseB91D37C29Ffe_GenericInfobox: description: Aggregated information on a generic entity from a knowledge graph. properties: attributes: default: [] description: A list of attributes about the entity. items: items: anyOf: - type: string - type: 'null' maxItems: 2 minItems: 2 type: array title: Attributes type: array category: anyOf: - type: string - type: 'null' description: Category classification for the entity. title: Category description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: A unit representing quantity relevant to the entity. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp found_in_urls: anyOf: - items: type: string type: array - type: 'null' description: List of URLs where the entity was found. title: Found In Urls images: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail type: array - type: 'null' description: A list of images relevant to the entity. title: Images is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean label: anyOf: - type: string - type: 'null' description: Any label associated with the entity. title: Label language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language long_desc: anyOf: - type: string - type: 'null' description: A longer description for the entity. title: Long Desc movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: >- Any movie data relevant to the entity. Appears only when the result is a movie. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched position: description: The position on a search result page. title: Position type: integer profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile type: array - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: The profiles associated with the entity. title: Profiles providers: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: A list of data sources for the entity. title: Providers ratings: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating type: array - type: 'null' description: Any ratings given to the entity. title: Ratings subtype: const: generic default: generic description: >- The infobox subtype identifier. The value is always generic. enum: - generic title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the entity. title: description: The title of the web page. title: Title type: string type: const: infobox default: infobox description: >- The infobox result type identifier. The value is always infobox. enum: - infobox title: Type type: string url: description: The URL where the page is served. title: Url type: string website_url: anyOf: - type: string - type: 'null' description: The official website pertaining to the entity. title: Website Url required: - title - url - position title: GenericInfobox type: object ResponseB91D37C29Ffe_InfoboxWithLocation: description: An infobox with location. properties: attributes: default: [] description: A list of attributes about the entity. items: items: anyOf: - type: string - type: 'null' maxItems: 2 minItems: 2 type: array title: Attributes type: array category: anyOf: - type: string - type: 'null' description: Category classification for the entity. title: Category coordinates: anyOf: - maxItems: 2 minItems: 2 prefixItems: - type: number - type: number type: array - type: 'null' description: The coordinates of the location. title: Coordinates description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: A unit representing quantity relevant to the entity. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp found_in_urls: anyOf: - items: type: string type: array - type: 'null' description: List of URLs where the entity was found. title: Found In Urls images: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail type: array - type: 'null' description: A list of images relevant to the entity. title: Images is_location: default: false description: Whether the entity is a location. title: Is Location type: boolean is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean label: anyOf: - type: string - type: 'null' description: Any label associated with the entity. title: Label language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language location: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' - type: 'null' description: The location result. long_desc: anyOf: - type: string - type: 'null' description: A longer description for the entity. title: Long Desc movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: >- Any movie data relevant to the entity. Appears only when the result is a movie. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched position: description: The position on a search result page. title: Position type: integer profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile type: array - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: The profiles associated with the entity. title: Profiles providers: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: A list of data sources for the entity. title: Providers ratings: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating type: array - type: 'null' description: Any ratings given to the entity. title: Ratings subtype: const: location default: location description: >- The infobox subtype identifier. The value is always location. enum: - location title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the entity. title: description: The title of the web page. title: Title type: string type: const: infobox default: infobox description: >- The infobox result type identifier. The value is always infobox. enum: - infobox title: Type type: string url: description: The URL where the page is served. title: Url type: string website_url: anyOf: - type: string - type: 'null' description: The official website pertaining to the entity. title: Website Url zoom_level: anyOf: - type: integer - type: 'null' description: The map zoom level. title: Zoom Level required: - title - url - position title: InfoboxWithLocation type: object ResponseB91D37C29Ffe_InfoboxPlace: description: An infobox for a place, such as a business. properties: attributes: default: [] description: A list of attributes about the entity. items: items: anyOf: - type: string - type: 'null' maxItems: 2 minItems: 2 type: array title: Attributes type: array category: anyOf: - type: string - type: 'null' description: Category classification for the entity. title: Category coordinates: anyOf: - maxItems: 2 minItems: 2 prefixItems: - type: number - type: number type: array - type: 'null' description: The coordinates of the location. title: Coordinates description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: A unit representing quantity relevant to the entity. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp found_in_urls: anyOf: - items: type: string type: array - type: 'null' description: List of URLs where the entity was found. title: Found In Urls images: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail type: array - type: 'null' description: A list of images relevant to the entity. title: Images is_location: default: false description: Whether the entity is a location. title: Is Location type: boolean is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean label: anyOf: - type: string - type: 'null' description: Any label associated with the entity. title: Label language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language location: $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' description: The location result. long_desc: anyOf: - type: string - type: 'null' description: A longer description for the entity. title: Long Desc movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: >- Any movie data relevant to the entity. Appears only when the result is a movie. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched position: description: The position on a search result page. title: Position type: integer profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile type: array - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: The profiles associated with the entity. title: Profiles providers: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: A list of data sources for the entity. title: Providers ratings: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating type: array - type: 'null' description: Any ratings given to the entity. title: Ratings subtype: const: place default: place description: >- The infobox subtype identifier. The value is always place. enum: - place title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the entity. title: description: The title of the web page. title: Title type: string type: const: infobox default: infobox description: >- The infobox result type identifier. The value is always infobox. enum: - infobox title: Type type: string url: description: The URL where the page is served. title: Url type: string website_url: anyOf: - type: string - type: 'null' description: The official website pertaining to the entity. title: Website Url zoom_level: anyOf: - type: integer - type: 'null' description: The map zoom level. title: Zoom Level required: - title - url - position - location title: InfoboxPlace type: object ResponseB91D37C29Ffe_LocationResult: description: A result that is location relevant. properties: action: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Action' - type: 'null' description: An action to be taken. categories: default: [] description: A list of categories. items: type: string title: Categories type: array contact: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Contact' - type: 'null' description: The contact of the business associated with the location. coordinates: anyOf: - maxItems: 2 minItems: 2 prefixItems: - type: number - type: number type: array - type: 'null' description: >- A list of coordinates associated with the location. This is a lat long represented as a floating point. title: Coordinates description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: The distance of the location from the client. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp icon_category: anyOf: - type: string - type: 'null' description: An icon category. title: Icon Category id: anyOf: - type: string - type: 'null' 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. title: Id is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language opening_hours: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_OpeningHours' - type: 'null' description: >- The opening hours, if it is a business, associated with the location. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched pictures: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_PictureResults' - type: 'null' description: A bunch of pictures associated with the business. postal_address: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_PostalAddress' - type: 'null' description: The postal address associated with the location. price_range: anyOf: - type: string - type: 'null' description: >- A display string used to show the price classification for the business. title: Price Range profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: Profiles associated with the business. title: Profiles provider_url: description: The complete URL of the provider. title: Provider Url type: string rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: The ratings of the business. results: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationWebResult' type: array - type: 'null' description: Web results related to this location. title: Results reviews: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Reviews' - type: 'null' description: Aggregated reviews from various sources relevant to the business. serves_cuisine: anyOf: - items: type: string type: array - type: 'null' description: A list of cuisine categories served. title: Serves Cuisine thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the location. timezone: anyOf: - type: string - type: 'null' description: IANA timezone identifier. title: Timezone timezone_offset: anyOf: - type: integer - type: 'null' description: The UTC offset of the timezone. title: Timezone Offset title: description: The title of the web page. title: Title type: string type: const: location_result default: location_result description: >- Location result type identifier. The value is always location_result. enum: - location_result title: Type type: string url: description: The URL where the page is served. title: Url type: string zoom_level: default: 7 description: The zoom level on the map. title: Zoom Level type: integer required: - title - url - provider_url title: LocationResult type: object ResponseB91D37C29Ffe_ResultReference: description: The ranking order of results on a search result page. properties: all: default: false description: Whether to put all the results from the type at specific position. title: All type: boolean index: anyOf: - type: integer - type: 'null' description: The 0th based index where the result should be placed. title: Index type: description: The type of the result. title: Type type: string required: - type title: ResultReference type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__NewsResult: description: A model representing news results. properties: age: anyOf: - type: string - type: 'null' description: >- A human-readable representation of the news article’s age. For example, 2 days ago. title: Age breaking: default: false description: Whether the news result is currently a breaking news. title: Breaking type: boolean description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description extra_snippets: anyOf: - items: type: string type: array - type: 'null' description: A list of extra alternate snippets for the news search result. title: Extra Snippets family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp icons: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon' type: array - type: 'null' description: Icons associated with the news result. title: Icons is_live: default: false description: Whether the news result is currently live. title: Is Live type: boolean is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language meta_url: anyOf: - type: object - type: 'null' description: The aggregated information on the URL representing a news result. title: Meta Url page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. source: anyOf: - type: string - type: 'null' description: The source of the news. title: Source thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the news result. title: description: The title of the web page. title: Title type: string url: description: The URL where the page is served. title: Url type: string required: - title - url title: NewsResult type: object ResponseB91D37C29Ffe_app__models__products__search__v1__language__Language: description: A model representing a language. properties: main: description: The main language seen in the string. title: Main type: string required: - main title: Language type: object ResponseB91D37C29Ffe_SearchOperators: properties: applied: default: false description: Whether search operators were applied to the query. title: Applied type: boolean cleaned_query: anyOf: - type: string - type: 'null' description: The query after search operators have been processed. title: Cleaned Query sites: anyOf: - items: type: string type: array - type: 'null' description: 'List of site domains extracted from site: operators.' title: Sites title: SearchOperators type: object ResponseB91D37C29Ffe_ResponseCallback: properties: callback_key: description: The unique key for the callback. title: Callback Key type: string vertical: $ref: '#/components/schemas/ResponseB91D37C29Ffe_SearchAPIVertical' description: >- The vertical associated with the callback. For the full list of verticals supported see the Rich Vertical list. required: - vertical - callback_key title: ResponseCallback type: object ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoResult: properties: age: anyOf: - type: string - type: 'null' description: >- A human-readable representation of the video’s age. For example, 2 days ago. title: Age description: anyOf: - type: string - type: 'null' description: The description for the video. title: Description fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp meta_url: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__MetaUrl - type: 'null' description: >- Aggregated information on the URL associated with the video search result. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: >- The ISO date time when the page was last fetched. The format is YYYY-MM-DDTHH:MM:SSZ. title: Page Fetched thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Thumbnail - type: 'null' description: The thumbnail for the video. title: description: The title of the video. title: Title type: string type: const: video_result default: video_result description: >- The type of video search API result. The value is always video_result. enum: - video_result title: Type type: string url: description: The source URL of the video. title: Url type: string video: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoData - type: 'null' description: Metadata for the video. required: - url - title title: VideoResult type: object ResponseB91D37C29Ffe_SearchResult: description: Aggregated information on a web search result, relevant to the query. properties: age: anyOf: - type: string - type: 'null' description: >- A human-readable representation of the web search result’s age. For example, 2 days ago. title: Age article: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Article' - type: 'null' description: An article found for the web search result page. book: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Book' - type: 'null' description: Any book information associated with the web search result page. cluster: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Result' type: array - type: 'null' description: A list of web search results. title: Cluster cluster_type: anyOf: - type: string - type: 'null' description: A type representing a cluster. The value can be product_cluster. title: Cluster Type content_type: anyOf: - type: string - type: 'null' description: The content type associated with the search result page. title: Content Type creative_work: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_CreativeWork' - type: 'null' description: >- Aggregated information on the creative work found on the web search result. deep_results: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_DeepResult' - type: 'null' description: Gathered information on a web search result. description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description extra_snippets: anyOf: - items: type: string type: array - type: 'null' description: A list of extra alternate snippets for the web search result. title: Extra Snippets family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean faq: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__FAQ - type: 'null' description: >- Any frequently asked questions associated with the web search result. fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp icons: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_PostprocessedIcon' type: array - type: 'null' description: Icons associated with the search result. title: Icons is_live: default: false description: >- Whether the web search result is currently live. Default value is false. title: Is Live type: boolean is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: default: en description: The main language on the web search result. title: Language type: string location: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' - type: 'null' description: The location details if the query relates to a restaurant. meta_url: anyOf: - type: object - type: 'null' description: >- Aggregated information on the URL associated with the web search result. title: Meta Url movie: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MovieData' - type: 'null' description: The movie associated with the web search result. music_recording: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_MusicRecording' - type: 'null' description: >- Aggregated information on music recording found on the web search result. organization: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Organization' - type: 'null' description: >- Aggregated information on a organization found on the web search result page. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched product: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Review' - type: 'null' description: >- The main product and a review that is found on the web search result page. title: Product product_cluster: anyOf: - items: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Review' type: array - type: 'null' description: >- A list of products and reviews that are found on the web search result page. title: Product Cluster profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. qa: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_QAPage' - type: 'null' description: >- Any question answer information associated with the web search result page. rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: Rating found for the web search result page. recipe: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Recipe' - type: 'null' description: >- Aggregated information on a recipe found on the web search result page. restaurant: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' - type: 'null' deprecated: true description: Deprecated. Use location instead. review: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Review' - type: 'null' description: Aggregated information on the review found on the web search result. schemas: anyOf: - items: {} type: array - type: 'null' 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. title: Schemas software: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Software' - type: 'null' description: >- Aggregated information on a software product found on the web search result page. subtype: default: generic description: A sub type identifying the web search result type. title: Subtype type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail of the web search result. title: description: The title of the web page. title: Title type: string type: const: search_result default: search_result description: >- A type identifying a web search result. The value is always search_result. enum: - search_result title: Type type: string url: description: The URL where the page is served. title: Url type: string video: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData - type: 'null' description: The video associated with the web search result. required: - title - url title: SearchResult type: object ResponseB91D37C29Ffe_Article: description: A model representing an article. properties: author: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' type: array - type: 'null' description: The author of the article. title: Author date: anyOf: - type: string - type: 'null' description: The date when the article was published. title: Date isAccessibleForFree: anyOf: - type: boolean - type: 'null' description: Whether the article is free to read or is behind a paywall. title: Isaccessibleforfree publisher: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Organization' - type: 'null' description: The name of the publisher for the article. thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: A thumbnail associated with the article. title: Article type: object ResponseB91D37C29Ffe_Book: description: A model representing a book result. properties: author: description: The author of the book. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' title: Author type: array date: anyOf: - type: string - type: 'null' description: The publishing date of the book. title: Date pages: anyOf: - type: integer - type: 'null' description: The number of pages in the book. title: Pages price: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Price' - type: 'null' description: The price of the book. publisher: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' - type: 'null' description: The publisher of the book. rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: A gathered rating from different sources associated with the book. title: description: The title of the book. title: Title type: string required: - title - author title: Book type: object ResponseB91D37C29Ffe_Result: description: A model representing a web search result. properties: description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. title: description: The title of the web page. title: Title type: string url: description: The URL where the page is served. title: Url type: string required: - title - url title: Result type: object ResponseB91D37C29Ffe_CreativeWork: description: >- A creative work relevant to the query. An example can be enriched metadata for an app. properties: name: description: The name of the creative work. minLength: 1 title: Name type: string rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: A rating that is given to the creative work. thumbnail: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail description: A thumbnail associated with the creative work. required: - name - thumbnail title: CreativeWork type: object ResponseB91D37C29Ffe_ForumData: description: Defines a result from a discussion forum. properties: forum_name: description: The name of the forum. title: Forum Name type: string num_answers: anyOf: - type: integer - type: 'null' description: The number of answers to the post. title: Num Answers question: anyOf: - type: string - type: 'null' description: The question asked in the forum post. title: Question score: anyOf: - type: string - type: 'null' description: The score of the post on the forum. title: Score title: anyOf: - type: string - type: 'null' description: The title of the post on the forum. title: Title top_comment: anyOf: - type: string - type: 'null' description: The top-rated comment under the forum post. title: Top Comment required: - forum_name title: ForumData type: object ResponseB91D37C29Ffe_DeepResult: description: Aggregated deep results from news, social, videos and images. properties: buttons: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_ButtonResult' type: array - type: 'null' description: A list of buttoned results associated with the result. title: Buttons images: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Image' type: array - type: 'null' description: Images associated with the result. title: Images news: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__NewsResult type: array - type: 'null' description: A list of news results associated with the result. title: News videos: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoResult type: array - type: 'null' description: Videos associated with the result. title: Videos title: DeepResult type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__FAQ: description: Frequently asked questions associated with a search result. properties: items: description: A list of question/answer pairs. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_QA' title: Items type: array required: - items title: FAQ type: object ResponseB91D37C29Ffe_PostprocessedIcon: properties: ext: anyOf: - type: string - type: 'null' title: Ext href: title: Href type: string rel: anyOf: - type: string - type: 'null' title: Rel sizes: anyOf: - type: string - type: 'null' title: Sizes type: anyOf: - type: string - type: 'null' title: Type required: - href - sizes - rel - type - ext title: PostprocessedIcon type: object ResponseB91D37C29Ffe_MovieData: description: Aggregated data for a movie result. properties: actors: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' type: array - type: 'null' description: A list of actors in the movie. title: Actors description: anyOf: - type: string - type: 'null' description: A short plot summary for the movie. title: Description directors: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' type: array - type: 'null' description: A list of people responsible for directing the movie. title: Directors duration: anyOf: - type: string - type: 'null' description: The runtime of the movie. The format is HH:MM:SS. title: Duration genre: anyOf: - items: type: string type: array - type: 'null' description: List of genres in which the movie can be classified. title: Genre name: anyOf: - type: string - type: 'null' description: Name of the movie. title: Name query: anyOf: - type: string - type: 'null' description: The query that resulted in the movie result. title: Query rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: Rating provided to the movie from various sources. release: anyOf: - type: string - type: 'null' description: The release date for the movie. title: Release thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: A thumbnail for a movie poster. url: anyOf: - type: string - type: 'null' description: A URL serving a movie profile page. title: Url title: MovieData type: object ResponseB91D37C29Ffe_MusicRecording: description: Result classified as a music label or a song. properties: name: description: The name of the song or album. minLength: 1 title: Name type: string rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: The rating of the music. thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: A thumbnail associated with the music. required: - name title: MusicRecording type: object ResponseB91D37C29Ffe_Organization: description: An entity responsible for another entity. properties: contact_points: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_ContactPoint' type: array - type: 'null' description: A list of contact points for the organization. title: Contact Points name: description: The name of the thing. title: Name type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: Thumbnail associated with the thing. type: default: organization description: >- A type string identifying an organization. The value is always organization. title: Type type: string url: anyOf: - type: string - type: 'null' description: A URL for the thing. title: Url required: - name title: Organization type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Product: description: A model representing a product. properties: category: anyOf: - type: string - type: 'null' description: The category of the product. title: Category description: anyOf: - type: string - type: 'null' description: The description of the product. title: Description gtin: anyOf: - type: string - type: 'null' description: A Global Trade Item Number (GTIN) for the product. title: Gtin gtin12: anyOf: - type: string - type: 'null' description: The GTIN-12 (UPC) code of the product. title: Gtin12 gtin13: anyOf: - type: string - type: 'null' description: The GTIN-13 (EAN/ISBN-13) code of the product. title: Gtin13 gtin14: anyOf: - type: string - type: 'null' description: The GTIN-14 code of the product. title: Gtin14 gtin8: anyOf: - type: string - type: 'null' description: The GTIN-8 (EAN/UCC-8) code of the product. title: Gtin8 name: description: The name of the product. minLength: 1 title: Name type: string offers: default: [] description: A list of offers available on the product. items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Offer title: Offers type: array price: description: The price of the product. title: Price type: string rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: A rating associated with the product. thumbnail: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail description: A thumbnail associated with the product. type: const: Product default: Product description: >- A string representing a product type. The value is always Product. enum: - Product title: Type type: string url: anyOf: - type: string - type: 'null' description: The URL of the product page. title: Url required: - name - price - thumbnail title: Product type: object ResponseB91D37C29Ffe_Review: description: A model representing a review for an entity. properties: description: description: A description of the review (the text of the review itself). title: Description type: string name: description: The review title for the review. title: Name type: string rating: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating description: The ratings associated with the review. thumbnail: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail description: The thumbnail associated with the reviewer. type: const: Review default: Review description: >- A string representing review type. This is always Review. enum: - Review title: Type type: string required: - name - thumbnail - description - rating title: Review type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile: description: A profile of an entity. properties: img: anyOf: - type: string - type: 'null' description: The served image URL representing the profile. title: Img long_name: anyOf: - type: string - type: 'null' description: The long name of the profile. title: Long Name name: description: The name of the profile. title: Name type: string url: description: The original URL where the profile is available. title: Url type: string required: - name - url title: Profile type: object ResponseB91D37C29Ffe_QAPage: description: Aggregated result from a question answer page. properties: answer: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Answer' description: An answer to the question. question: description: The question that is being asked. title: Question type: string required: - question - answer title: QAPage type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating: description: The rating associated with an entity. properties: bestRating: description: Best rating received. exclusiveMinimum: 0 title: Bestrating type: number is_tripadvisor: default: false description: Whether the rating is coming from Tripadvisor. title: Is Tripadvisor type: boolean profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: The profile associated with the rating. ratingValue: description: The current value of the rating. minimum: 0 title: Ratingvalue type: number reviewCount: anyOf: - type: integer - type: 'null' description: The number of reviews associated with the rating. title: Reviewcount required: - ratingValue - bestRating title: Rating type: object ResponseB91D37C29Ffe_Recipe: description: Aggregated information on a recipe. properties: calories: anyOf: - type: integer - type: 'null' description: Calorie count for the recipe. title: Calories cook_time: anyOf: - type: string - type: 'null' description: The cooking time for the recipe. title: Cook Time description: description: The description of the recipe. title: Description type: string domain: description: The domain of the web page where the recipe was found. title: Domain type: string favicon: description: The URL for the favicon of the web page where the recipe was found. title: Favicon type: string ingredients: anyOf: - type: string - type: 'null' description: Ingredients required for the recipe. title: Ingredients instructions: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_HowTo' type: array - type: 'null' description: List of instructions for the recipe. title: Instructions prep_time: anyOf: - type: string - type: 'null' description: The preparation time for the recipe. title: Prep Time publisher: anyOf: - type: string - type: 'null' description: The publisher of the recipe. title: Publisher rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_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' description: The category of the recipe. title: Recipecategory recipeCuisine: anyOf: - type: string - type: 'null' description: The cuisine classification for the recipe. title: Recipecuisine servings: anyOf: - type: integer - type: 'null' description: How many people the recipe serves. title: Servings thumbnail: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail description: A thumbnail associated with the recipe. time: anyOf: - type: string - type: 'null' description: The total time required to cook the recipe. title: Time title: description: The title of the recipe. title: Title type: string url: description: The URL of the web page where the recipe was found. title: Url type: string video: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData - type: 'null' description: >- Aggregated information on the cooking video associated with the recipe. required: - title - description - thumbnail - url - domain - favicon title: Recipe type: object ResponseB91D37C29Ffe_Software: description: A model representing a software entity. properties: author: anyOf: - type: string - type: 'null' description: The author of software product. title: Author codeRepository: anyOf: - type: string - type: 'null' description: >- The code repository where the software product is currently available or maintained. title: Coderepository datePublished: anyOf: - type: string - type: 'null' description: The date when the software product was published. title: Datepublished forks: anyOf: - type: integer - type: 'null' description: The numbers of forks of the repository. title: Forks homepage: anyOf: - type: string - type: 'null' description: The home page of the software product. title: Homepage is_npm: anyOf: - type: boolean - type: 'null' description: Whether the software product is available on npm. title: Is Npm is_pypi: anyOf: - type: boolean - type: 'null' description: Whether the software product is available on pypi. title: Is Pypi name: anyOf: - type: string - type: 'null' description: The name of the software product. title: Name programmingLanguage: anyOf: - type: string - type: 'null' description: The programming language spread on the software product. title: Programminglanguage stars: anyOf: - type: integer - type: 'null' description: The number of stars on the repository. title: Stars version: anyOf: - type: string - type: 'null' description: The latest version of the software product. title: Version title: Software type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail: description: Aggregated details representing a picture thumbnail. properties: alt: anyOf: - type: string - type: 'null' description: The alt text for the thumbnail image. title: Alt bg_color: anyOf: - type: string - type: 'null' description: The background color of the thumbnail. title: Bg Color duplicated: anyOf: - type: boolean - type: 'null' description: Whether the thumbnail is a duplicate. title: Duplicated height: anyOf: - type: integer - type: 'null' description: The height of the thumbnail. title: Height logo: anyOf: - type: boolean - type: 'null' description: Whether the thumbnail is a logo. title: Logo original: anyOf: - type: string - type: 'null' description: The original URL of the image. title: Original src: description: The served URL of the picture thumbnail. title: Src type: string theme: anyOf: - type: string - type: 'null' description: The theme of the thumbnail (e.g., light or dark). title: Theme width: anyOf: - type: integer - type: 'null' description: The width of the thumbnail. title: Width required: - src title: Thumbnail type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData: description: A model representing metadata gathered for a video. properties: author: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: Author of the video. creator: anyOf: - type: string - type: 'null' description: The creator of the video. title: Creator duration: anyOf: - type: string - type: 'null' description: >- A time string representing the duration of the video. The format can be HH:MM:SS or MM:SS. title: Duration publisher: anyOf: - type: string - type: 'null' description: The publisher of the video. title: Publisher requires_subscription: anyOf: - type: boolean - type: 'null' description: Whether the video requires a subscription to watch. title: Requires Subscription tags: anyOf: - items: type: string type: array - type: 'null' description: A list of tags associated with the video. title: Tags thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: A thumbnail associated with the video. views: anyOf: - type: string - type: 'null' description: The number of views of the video. title: Views title: VideoData type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl: description: Aggregated information about a URL. properties: favicon: description: The favicon used for the URL. title: Favicon type: string hostname: anyOf: - type: string - type: 'null' description: The lowercased domain name extracted from the URL. title: Hostname netloc: description: The network location part extracted from the URL. title: Netloc type: string path: description: The hierarchical path of the URL useful as a display string. title: Path type: string scheme: description: The protocol scheme extracted from the URL. title: Scheme type: string required: - scheme - netloc - favicon - path title: MetaUrl type: object ResponseB91D37C29Ffe_Unit: description: A model representing a unit of measurement. properties: units: description: The name of the unit associated with the quantity. title: Units type: string value: description: The quantity of the unit. title: Value type: number required: - value - units title: Unit type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider: description: A model representing the data provider associated with the entity. properties: img: anyOf: - type: string - type: 'null' description: The served URL for the image data. title: Img long_name: anyOf: - type: string - type: 'null' description: The long name for the data provider. title: Long Name name: description: The name of the data provider. This can be a domain. title: Name type: string type: const: external default: external description: >- The type representing the source of data. This is usually external. enum: - external title: Type type: string url: description: The URL where the information is coming from. title: Url type: string required: - name - url title: DataProvider type: object ResponseB91D37C29Ffe_Action: description: A model representing an action to be taken. properties: type: description: The type representing the action. title: Type type: string url: description: A URL representing the action to be taken. title: Url type: string required: - type - url title: Action type: object ResponseB91D37C29Ffe_Contact: description: A model representing contact information for an entity. properties: email: anyOf: - type: string - type: 'null' description: The email address. title: Email telephone: anyOf: - type: string - type: 'null' description: The telephone number. title: Telephone title: Contact type: object ResponseB91D37C29Ffe_OpeningHours: description: Opening hours of a business at a particular location. properties: current_day: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_DayOpeningHours' type: array - type: 'null' description: The current day opening hours. Can have two sets of opening hours. title: Current Day days: anyOf: - items: items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_DayOpeningHours' type: array type: array - type: 'null' description: The opening hours for the whole week. title: Days title: OpeningHours type: object ResponseB91D37C29Ffe_PictureResults: description: A model representing a list of pictures. properties: results: description: A list of thumbnail results. items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail title: Results type: array viewMoreUrl: anyOf: - type: string - type: 'null' description: A URL to view more pictures. title: Viewmoreurl required: - viewMoreUrl - results title: PictureResults type: object ResponseB91D37C29Ffe_PostalAddress: description: A model representing a postal address of a location. properties: addressLocality: anyOf: - type: string - type: 'null' description: The address locality or subregion associated with the location. title: Addresslocality addressRegion: anyOf: - type: string - type: 'null' description: The region associated with the location. This is usually a state. title: Addressregion country: anyOf: - type: string - type: 'null' description: The country associated with the location. title: Country displayAddress: description: The displayed address string. title: Displayaddress type: string postalCode: anyOf: - type: string - type: 'null' description: The postal code associated with the location. title: Postalcode streetAddress: anyOf: - type: string - type: 'null' description: The street address associated with the location. title: Streetaddress type: const: PostalAddress default: PostalAddress description: >- The type identifying a postal address. The value is always PostalAddress. enum: - PostalAddress title: Type type: string required: - displayAddress title: PostalAddress type: object ResponseB91D37C29Ffe_LocationWebResult: description: A model representing a web result related to a location. properties: description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language meta_url: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl description: Aggregated information about the URL. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. title: description: The title of the web page. title: Title type: string url: description: The URL where the page is served. title: Url type: string required: - title - url - meta_url title: LocationWebResult type: object ResponseB91D37C29Ffe_Reviews: description: The reviews associated with an entity. properties: results: description: A list of trip advisor reviews for the entity. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_TripadvisorReview' title: Results type: array reviews_in_foreign_language: description: Any reviews available in a foreign language. title: Reviews In Foreign Language type: boolean viewMoreUrl: description: >- A URL to a web page where more information on the result can be seen. title: Viewmoreurl type: string required: - results - viewMoreUrl - reviews_in_foreign_language title: Reviews type: object ResponseB91D37C29Ffe_SearchAPIVertical: enum: - calculator - cryptocurrency - currency - definitions - formula1 - packagetracker - sports - stocks - unitconversion - unixtimestamp - weather title: SearchAPIVertical type: string ResponseB91D37C29Ffe_app__models__products__search__v1__videos__MetaUrl: properties: favicon: anyOf: - type: string - type: 'null' description: The favicon used for the URL. title: Favicon hostname: anyOf: - type: string - type: 'null' description: The lowercased domain name extracted from the URL. title: Hostname netloc: anyOf: - type: string - type: 'null' description: The network location part extracted from the URL. title: Netloc path: anyOf: - type: string - type: 'null' description: The hierarchical path of the URL useful as a display string. title: Path scheme: anyOf: - type: string - type: 'null' description: The protocol scheme extracted from the URL. title: Scheme title: MetaUrl type: object ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Thumbnail: properties: original: anyOf: - type: string - type: 'null' description: The original URL of the thumbnail associated with the video. title: Original src: description: The served URL of the thumbnail associated with the video. title: Src type: string required: - src title: Thumbnail type: object ResponseB91D37C29Ffe_app__models__products__search__v1__videos__VideoData: properties: author: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Profile - type: 'null' description: A profile associated with the video. creator: anyOf: - type: string - type: 'null' description: The creator of the video. title: Creator duration: anyOf: - type: string - type: 'null' description: A time string representing the duration of the video. title: Duration publisher: anyOf: - type: string - type: 'null' description: The publisher of the video. title: Publisher requires_subscription: anyOf: - type: boolean - type: 'null' description: Whether the video requires a subscription. title: Requires Subscription tags: anyOf: - items: type: string type: array - type: 'null' description: A list of tags relevant to the video. title: Tags views: anyOf: - type: integer - type: 'null' description: The number of views of the video. title: Views title: VideoData type: object ResponseB91D37C29Ffe_Person: description: A model describing a person entity. properties: email: anyOf: - type: string - type: 'null' description: Email address of the person. title: Email name: description: The name of the thing. title: Name type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: Thumbnail associated with the thing. type: const: person default: person description: >- A type identifying a person. The value is always person. enum: - person title: Type type: string url: anyOf: - type: string - type: 'null' description: A URL for the thing. title: Url required: - name title: Person type: object ResponseB91D37C29Ffe_Price: description: A model representing the price for an entity. properties: price: description: The price value in a given currency. title: Price type: string priceCurrency: description: The currency of the price value. title: Pricecurrency type: string required: - price - priceCurrency title: Price type: object ResponseB91D37C29Ffe_ButtonResult: description: A result which can be used as a button. properties: title: description: The title of the result. title: Title type: string type: const: button_result default: button_result description: >- A type identifying button result. The value is always button_result. enum: - button_result title: Type type: string url: description: The URL for the button result. title: Url type: string required: - title - url title: ButtonResult type: object ResponseB91D37C29Ffe_Image: description: A model describing an image. properties: properties: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_ImageProperties' - type: 'null' description: Metadata on the image. thumbnail: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail description: The thumbnail associated with the image. url: anyOf: - type: string - type: 'null' description: The URL of the image. title: Url required: - thumbnail title: Image type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoResult: description: A model representing a video result. properties: age: anyOf: - type: string - type: 'null' description: >- A human-readable representation of the video’s age. For example, 2 days ago. title: Age description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language meta_url: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl - type: 'null' description: Aggregated information on the URL. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. publisher: anyOf: - type: string - type: 'null' description: The publisher of the video. title: Publisher thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail of the video. title: description: The title of the web page. title: Title type: string type: const: video_result default: video_result description: >- The type identifying the video result. The value is always video_result. enum: - video_result title: Type type: string url: description: The URL where the page is served. title: Url type: string video: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__VideoData description: Meta data for the video. required: - title - url - video title: VideoResult type: object ResponseB91D37C29Ffe_ContactPoint: description: A way to contact an entity. properties: email: anyOf: - type: string - type: 'null' description: The email address of the entity. title: Email name: description: The name of the thing. title: Name type: string telephone: anyOf: - type: string - type: 'null' description: The telephone number of the entity. title: Telephone thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: Thumbnail associated with the thing. type: default: contact_point description: >- A type string identifying a contact point. The value is always contact_point. title: Type type: string url: anyOf: - type: string - type: 'null' description: A URL for the thing. title: Url required: - name title: ContactPoint type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Offer: description: An offer associated with a product. properties: price: description: The price of the product currently on offer. title: Price type: string priceCurrency: description: The currency in which the offer is made. title: Pricecurrency type: string url: description: The URL where the offer can be found. title: Url type: string required: - url - priceCurrency - price title: Offer type: object ResponseB91D37C29Ffe_Answer: description: A response representing an answer to a question on a forum. properties: author: anyOf: - type: string - type: 'null' description: The name of the author of the answer. title: Author downvoteCount: anyOf: - type: integer - type: 'null' description: The number of downvotes on the answer. title: Downvotecount text: description: The main content of the answer. title: Text type: string upvoteCount: anyOf: - type: integer - type: 'null' description: Number of upvotes on the answer. title: Upvotecount required: - text title: Answer type: object ResponseB91D37C29Ffe_HowTo: description: Aggregated information on a how to. properties: image: anyOf: - items: type: string type: array - type: 'null' description: A list of image URLs associated with the how to. title: Image name: anyOf: - type: string - type: 'null' description: A name for the how to. title: Name text: description: The how to text. title: Text type: string url: anyOf: - type: string - type: 'null' description: A URL associated with the how to. title: Url required: - text title: HowTo type: object ResponseB91D37C29Ffe_DayOpeningHours: description: >- A model representing the opening hours for a particular day for a business at a particular location. properties: abbr_name: description: A short string representing the day of the week. title: Abbr Name type: string closes: description: >- A 24 hr clock time string for the closing time of the business on a particular day. title: Closes type: string full_name: description: A full string representing the day of the week. title: Full Name type: string opens: description: >- A 24 hr clock time string for the opening time of the business on a particular day. title: Opens type: string required: - abbr_name - full_name - opens - closes title: DayOpeningHours type: object ResponseB91D37C29Ffe_TripadvisorReview: description: A model representing a Tripadvisor review. properties: author: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' description: The author of the review. date: description: The date when the review was published. title: Date type: string description: description: A description seen in the review. title: Description type: string language: description: The language of the review. title: Language type: string rating: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating description: A rating given by the reviewer. review_url: description: A URL link to the page where the review can be found. title: Review Url type: string title: description: The title of the review. title: Title type: string required: - title - description - date - rating - author - review_url - language title: TripadvisorReview type: object ResponseB91D37C29Ffe_app__models__products__search__v1__videos__Profile: properties: img: anyOf: - type: string - type: 'null' description: The served image URL representing the profile. title: Img long_name: anyOf: - type: string - type: 'null' description: The long name of the profile. title: Long Name name: description: The name of the profile. title: Name type: string url: description: The original URL where the profile is available. title: Url type: string required: - name - url title: Profile type: object ResponseB91D37C29Ffe_ImageProperties: description: Metadata on an image. properties: content_size: anyOf: - type: string - type: 'null' description: The image size. title: Content Size format: anyOf: - type: string - type: 'null' description: The image format. title: Format height: anyOf: - type: integer - type: 'null' description: The image height. title: Height placeholder: description: The placeholder image URL. title: Placeholder type: string resized: description: The URL for a better quality resized image. title: Resized type: string url: description: The original image URL. title: Url type: string width: anyOf: - type: integer - type: 'null' description: The image width. title: Width required: - url - resized - placeholder title: ImageProperties type: object securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.