{ "openapi": "3.1.0", "info": { "title": "AIsa MPP Data APIs", "version": "2.0.0", "contact": { "url": "https://aisa.one", "email": "developer@aisa.one" }, "description": "Reviewed synchronous read-only APIs. Prices reflect the verified public PAYG quote; inspect the current 402 challenge before payment.", "x-guidance": "GET uses query/path parameters. Read-only POST uses the documented requestBody. Request without credentials to inspect the 402 WWW-Authenticate challenge, then retry the same request and X-Request-ID with Authorization: Payment . Failed payment records do not imply an on-chain refund." }, "servers": [ { "url": "https://api.aisa.one" } ], "paths": { "/apis/v1/brave/images/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_d16c20eca148__any_brave_search_apis_v1_brave_images_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 number of search results returned in response. The maximum is 200. The actual number delivered may be less than requested.

\n

NOTE: Image search is not paginated and has no offset parameter. Raise count to get more results.

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

The number of search results returned in response. The maximum is 200. The actual number delivered may be less than requested.

\n

NOTE: Image search is not paginated and has no offset parameter. Raise count to get more results.

", "maximum": 200, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries and ALL for worldwide.", "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries and ALL for worldwide." } }, { "deprecated": false, "description": "The user\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "in": "query", "name": "q", "required": true, "schema": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "maxLength": 400, "minLength": 1, "title": "Q", "type": "string" } }, { "deprecated": false, "description": "

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

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

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

\n", "examples": [ "off", "strict" ], "title": "Safe search" } }, { "deprecated": false, "description": "The search language preference. 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 search language preference. The 2 or more character language code for which the search results are provided." } }, { "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": { "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_ImageSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Image Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/llm/context": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_7826339177ff__get_any_brave_search_apis_v1_brave_llm_context", "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": "Ann Arbor" } }, "in": "header", "name": "x-loc-city", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The generic name of the client city", "title": "X-Loc-City" } }, { "deprecated": false, "description": "The two letter country code for the client\u2019s country. For a list of country codes, see ISO 3166-1 alpha-2", "examples": { "Country alpha-2 code": { "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\u2019s country. For a list of country codes, see ISO 3166-1 alpha-2", "title": "X-Loc-Country" } }, { "deprecated": false, "description": "The latitude of the client\u2019s 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": { "None": {} }, "in": "header", "name": "x-loc-lat", "required": false, "schema": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "description": "The latitude of the client\u2019s 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.", "title": "X-Loc-Lat" } }, { "deprecated": false, "description": "The longitude of the client\u2019s 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": { "None": {} }, "in": "header", "name": "x-loc-long", "required": false, "schema": { "anyOf": [ { "maximum": 180, "minimum": -180, "type": "number" }, { "type": "null" } ], "description": "The longitude of the client\u2019s 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.", "title": "X-Loc-Long" } }, { "deprecated": false, "description": "The client\u2019s postal code", "examples": { "Postal code in Ann Harbor, Michigan, US": { "value": "48105" } }, "in": "header", "name": "x-loc-postal-code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client\u2019s postal code", "title": "X-Loc-Postal-Code" } }, { "deprecated": false, "description": "A code which could be up to three characters, that represent the client\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": { "Michigan State/Region code in USA": { "value": "MI" } }, "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\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State" } }, { "deprecated": false, "description": "The name of the client\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": { "Michigan generic state name in USA": { "value": "Michigan" } }, "in": "header", "name": "x-loc-state-name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the client\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State-Name" } }, { "deprecated": false, "description": "The mode to use to determine the threshold for including content in context.", "in": "query", "name": "context_threshold_mode", "required": false, "schema": { "anyOf": [ { "enum": [ "disabled", "strict", "lenient", "balanced" ], "title": "SummarizerContextThresholdMode", "type": "string" }, { "type": "null" } ], "description": "The mode to use to determine the threshold for including content in context.", "title": "Context Threshold Mode" } }, { "deprecated": false, "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "in": "query", "name": "count", "required": false, "schema": { "default": 20, "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries.", "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries." } }, { "deprecated": false, "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City).", "in": "query", "name": "enable_local", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City).", "title": "Enable Local" } }, { "deprecated": false, "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "in": "query", "name": "enable_source_metadata", "required": false, "schema": { "default": false, "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "title": "Enable Source Metadata", "type": "boolean" } }, { "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\u2019s 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": { "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$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\u2019s 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": false, "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "in": "query", "name": "maximum_number_of_snippets", "required": false, "schema": { "default": 50, "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "maximum": 256, "minimum": 1, "title": "Maximum Number Of Snippets", "type": "integer" } }, { "deprecated": false, "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "in": "query", "name": "maximum_number_of_snippets_per_url", "required": false, "schema": { "default": 50, "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "maximum": 100, "minimum": 1, "title": "Maximum Number Of Snippets Per Url", "type": "integer" } }, { "deprecated": false, "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "in": "query", "name": "maximum_number_of_tokens", "required": false, "schema": { "default": 8192, "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "maximum": 32768, "minimum": 1024, "title": "Maximum Number Of Tokens", "type": "integer" } }, { "deprecated": false, "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "in": "query", "name": "maximum_number_of_tokens_per_url", "required": false, "schema": { "default": 4096, "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "maximum": 8192, "minimum": 512, "title": "Maximum Number Of Tokens Per Url", "type": "integer" } }, { "deprecated": false, "description": "Maximum number of different URLs to include in LLM context.", "in": "query", "name": "maximum_number_of_urls", "required": false, "schema": { "default": 20, "description": "Maximum number of different URLs to include in LLM context.", "maximum": 50, "minimum": 1, "title": "Maximum Number Of Urls", "type": "integer" } }, { "deprecated": false, "description": "The user\u2019s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "in": "query", "name": "q", "required": true, "schema": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "maxLength": 600, "minLength": 1, "title": "Q", "type": "string" } }, { "deprecated": false, "description": "

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

\n\n

When not set, no filtering is applied \u2014 except for local recall, which stays strict.

", "in": "query", "name": "safesearch", "required": false, "schema": { "anyOf": [ { "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch", "type": "string" }, { "type": "null" } ], "description": "

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

\n\n

When not set, no filtering is applied \u2014 except for local recall, which stays strict.

", "title": "Safe search" } }, { "deprecated": false, "description": "The search language preference. 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 search language preference. The 2 or more character language code for which the search results are provided." } }, { "deprecated": false, "description": "Whether to enable spellcheck on the query.", "in": "query", "name": "spellcheck", "required": false, "schema": { "default": true, "description": "Whether to enable spellcheck on the query.", "title": "Spellcheck", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_LLMContextAPIResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "LLM Context", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_0e9bbdfa3b1e__post_any_brave_search_apis_v1_brave_llm_context", "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": "Ann Arbor" } }, "in": "header", "name": "x-loc-city", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The generic name of the client city", "title": "X-Loc-City" } }, { "deprecated": false, "description": "The two letter country code for the client\u2019s country. For a list of country codes, see ISO 3166-1 alpha-2", "examples": { "Country alpha-2 code": { "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\u2019s country. For a list of country codes, see ISO 3166-1 alpha-2", "title": "X-Loc-Country" } }, { "deprecated": false, "description": "The latitude of the client\u2019s 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": { "None": {} }, "in": "header", "name": "x-loc-lat", "required": false, "schema": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "description": "The latitude of the client\u2019s 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.", "title": "X-Loc-Lat" } }, { "deprecated": false, "description": "The longitude of the client\u2019s 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": { "None": {} }, "in": "header", "name": "x-loc-long", "required": false, "schema": { "anyOf": [ { "maximum": 180, "minimum": -180, "type": "number" }, { "type": "null" } ], "description": "The longitude of the client\u2019s 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.", "title": "X-Loc-Long" } }, { "deprecated": false, "description": "The client\u2019s postal code", "examples": { "Postal code in Ann Harbor, Michigan, US": { "value": "48105" } }, "in": "header", "name": "x-loc-postal-code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client\u2019s postal code", "title": "X-Loc-Postal-Code" } }, { "deprecated": false, "description": "A code which could be up to three characters, that represent the client\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": { "Michigan State/Region code in USA": { "value": "MI" } }, "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\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State" } }, { "deprecated": false, "description": "The name of the client\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "examples": { "Michigan generic state name in USA": { "value": "Michigan" } }, "in": "header", "name": "x-loc-state-name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the client\u2019s state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.", "title": "X-Loc-State-Name" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "context_threshold_mode": { "anyOf": [ { "enum": [ "disabled", "strict", "lenient", "balanced" ], "title": "SummarizerContextThresholdMode", "type": "string" }, { "type": "null" } ], "description": "The mode to use to determine the threshold for including content in context." }, "count": { "default": 20, "description": "The maximum number of search results considered to select the LLM context data. The default is 20 and the maximum is 50.", "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" }, "country": { "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries." }, "enable_local": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether to enable local recall. Not setting this value means auto-detect: local recall is used if a location is provided (X-Loc-Lat with X-Loc-Long, or X-Loc-City).", "title": "Enable Local" }, "enable_source_metadata": { "default": false, "description": "Enable source metadata enrichment (site_name, favicon, thumbnail, description, fetched_content_timestamp) in the sources attribute of the response.", "title": "Enable Source Metadata", "type": "boolean" }, "freshness": { "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" }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave\u2019s 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" }, "maximum_number_of_snippets": { "default": 50, "description": "Maximum number of different snippets (or chunks of text) to include in LLM context. The default is 50 and maximum is 256.", "maximum": 256, "minimum": 1, "title": "Maximum Number Of Snippets", "type": "integer" }, "maximum_number_of_snippets_per_url": { "default": 50, "description": "Maximum number of snippets to include per URL. The default is 50 and maximum is 100.", "maximum": 100, "minimum": 1, "title": "Maximum Number Of Snippets Per Url", "type": "integer" }, "maximum_number_of_tokens": { "default": 8192, "description": "Approximate maximum number of tokens to include in context. The default is 8192 and maximum is 32768.", "maximum": 32768, "minimum": 1024, "title": "Maximum Number Of Tokens", "type": "integer" }, "maximum_number_of_tokens_per_url": { "default": 4096, "description": "Maximum number of tokens to include per URL. The default is 4096 and maximum is 8192.", "maximum": 8192, "minimum": 512, "title": "Maximum Number Of Tokens Per Url", "type": "integer" }, "maximum_number_of_urls": { "default": 20, "description": "Maximum number of different URLs to include in LLM context.", "maximum": 50, "minimum": 1, "title": "Maximum Number Of Urls", "type": "integer" }, "q": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query.", "maxLength": 600, "minLength": 1, "title": "Q", "type": "string" }, "safesearch": { "anyOf": [ { "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch", "type": "string" }, { "type": "null" } ], "description": "

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

\n\n

When not set, no filtering is applied \u2014 except for local recall, which stays strict.

", "title": "Safe search" }, "search_lang": { "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 search language preference. The 2 or more character language code for which the search results are provided." }, "spellcheck": { "default": true, "description": "Whether to enable spellcheck on the query.", "title": "Spellcheck", "type": "boolean" } }, "required": [ "q" ], "title": "LLMContextParameters", "type": "object" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextAPIResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "LLM Context", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/local/descriptions": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_a8042c2839ba__any_brave_search_apis_v1_brave_local_descriptions", "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": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "in": "query", "name": "ids", "required": true, "schema": { "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "items": { "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Ids", "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_a8042c2839ba__Response762Cca4421D2_LocalDescriptionsSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "POI Descriptions", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/local/place_search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_0000e68d5a2c__any_brave_search_apis_v1_brave_local_place_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": "Number of results to return. The maximum is 100.", "in": "query", "name": "count", "required": false, "schema": { "default": 20, "description": "Number of results to return. The maximum is 100.", "maximum": 100, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "Two-letter country code (ISO 3166-1 alpha-2) to scope the search.", "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": "Two-letter country code (ISO 3166-1 alpha-2) to scope the search." } }, { "deprecated": false, "description": "Optional geolocation of the user in the format <latitude>x<longitude>. Used to calculate distance values in results.", "in": "query", "name": "geoloc", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional geolocation of the user in the format <latitude>x<longitude>. Used to calculate distance values in results.", "title": "Geoloc" } }, { "deprecated": false, "description": "Latitude of the geographical coordinates.", "in": "query", "name": "latitude", "required": false, "schema": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "description": "Latitude of the geographical coordinates.", "title": "Latitude" } }, { "deprecated": false, "description": "

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

\n", "in": "query", "name": "location", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "

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

\n", "title": "Location" } }, { "deprecated": false, "description": "Longitude of the geographical coordinates.", "in": "query", "name": "longitude", "required": false, "schema": { "anyOf": [ { "maximum": 180, "minimum": -180, "type": "number" }, { "type": "null" } ], "description": "Longitude of the geographical coordinates.", "title": "Longitude" } }, { "deprecated": false, "description": "Query string to search for points of interest in an area. If no q is provided, the endpoint will return general points of interest in the given area.", "in": "query", "name": "q", "required": false, "schema": { "default": "", "description": "Query string to search for points of interest in an area. If no q is provided, the endpoint will return general points of interest in the given area.", "title": "Q", "type": "string" } }, { "deprecated": false, "description": "Search radius bias around the given coordinates, in meters. NOTE: This is not strictly the radius of the search (nor the resulting radius of the results), but rather a bias towards results that are closer to the given coordinates. Search is performed globally if no radius is provided.", "in": "query", "name": "radius", "required": false, "schema": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "description": "Search radius bias around the given coordinates, in meters. NOTE: This is not strictly the radius of the search (nor the resulting radius of the results), but rather a bias towards results that are closer to the given coordinates. Search is performed globally if no radius is provided.", "title": "Radius" } }, { "deprecated": false, "description": "Safe search level for the query results.", "in": "query", "name": "safesearch", "required": false, "schema": { "allOf": [ { "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch", "type": "string" }, { "default": "strict" } ], "description": "Safe search level for the query results." } }, { "deprecated": false, "description": "Language for the search results.", "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": "Language for the search results." } }, { "deprecated": false, "description": "Whether to apply spellcheck before executing the search.", "in": "query", "name": "spellcheck", "required": false, "schema": { "default": true, "description": "Whether to apply spellcheck before executing the search.", "title": "Spellcheck", "type": "boolean" } }, { "deprecated": false, "description": "User interface language for the response. Usually <language>-<region>.", "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 for the response. Usually <language>-<region>." } }, { "deprecated": false, "description": "Units of measurement for distance values: metric is kilometres, imperial is miles.", "in": "query", "name": "units", "required": false, "schema": { "allOf": [ { "enum": [ "imperial", "metric" ], "title": "MeasurementUnit", "type": "string" }, { "default": "metric" } ], "description": "Units of measurement for distance values: metric is kilometres, imperial is miles." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_LocalPlaceSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Place Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/local/pois": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_7637e45b1e94__any_brave_search_apis_v1_brave_local_pois", "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 latitude of the client\u2019s 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.", "in": "header", "name": "x-loc-lat", "required": false, "schema": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "description": "The latitude of the client\u2019s 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.", "title": "X-Loc-Lat" } }, { "deprecated": false, "description": "The longitude of the client\u2019s 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.", "in": "header", "name": "x-loc-long", "required": false, "schema": { "anyOf": [ { "maximum": 180, "minimum": -180, "type": "number" }, { "type": "null" } ], "description": "The longitude of the client\u2019s 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.", "title": "X-Loc-Long" } }, { "deprecated": false, "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "in": "query", "name": "ids", "required": true, "schema": { "description": "A list of unique identifiers for the location. The ids are valid only for 8 hours.", "items": { "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Ids", "type": "array" } }, { "deprecated": false, "description": "The search language preference. 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 search language preference. The 2 or more character language code for which the search results are provided." } }, { "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." } }, { "deprecated": false, "description": "

The measurement units. The following values are supported:

\n", "examples": { "Imperial units": { "value": "imperial" }, "Metric units": { "value": "metric" } }, "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", "title": "Units" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_LocalPoiSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Local POIs", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/news/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_c8e02c744dde__get_any_brave_search_apis_v1_brave_news_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 number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "in": "query", "name": "count", "required": false, "schema": { "default": 20, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.", "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." } }, { "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": { "Exclude extra snippets": { "value": false }, "Include extra snippets": { "value": true } }, "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.", "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\u2019s 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$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\u2019s 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": false, "description": "Include fetch metadata.", "examples": { "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "include_fetch_metadata", "required": false, "schema": { "default": false, "description": "Include fetch metadata.", "examples": [ true, false ], "title": "Include Fetch Metadata", "type": "boolean" } }, { "deprecated": false, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "maximum": 9, "minimum": 0, "title": "Offset", "type": "integer" } }, { "deprecated": false, "description": "Whether to apply search operators.", "examples": { "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\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "in": "query", "name": "q", "required": true, "schema": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "maxLength": 400, "minLength": 1, "title": "The user's search query term.", "type": "string" } }, { "deprecated": false, "description": "

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

\n", "examples": { "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": "strict" } ], "description": "

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

\n", "examples": [ "off", "moderate", "strict" ], "title": "Safe search" } }, { "deprecated": false, "description": "The search language preference. 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 search language preference. The 2 or more character language code for which the search results are provided." } }, { "deprecated": false, "description": "Whether to spell check the provided query. If the spellchecker 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": { "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "spellcheck", "required": false, "schema": { "default": true, "description": "Whether to spell check the provided query. If the spellchecker 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": "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." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_NewsSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "News Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_2321b7aba760__post_any_brave_search_apis_v1_brave_news_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" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "count": { "default": 20, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" }, "country": { "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." }, "extra_snippets": { "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.", "title": "Extra Snippets" }, "freshness": { "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" }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave\u2019s 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" }, "include_fetch_metadata": { "default": false, "description": "Include fetch metadata.", "examples": [ true, false ], "title": "Include Fetch Metadata", "type": "boolean" }, "offset": { "default": 0, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "maximum": 9, "minimum": 0, "title": "Offset", "type": "integer" }, "operators": { "default": true, "description": "Whether to apply search operators.", "examples": [ true, false ], "title": "Operators", "type": "boolean" }, "q": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "maxLength": 400, "minLength": 1, "title": "The user's search query term.", "type": "string" }, "safesearch": { "allOf": [ { "enum": [ "off", "moderate", "strict" ], "title": "SafeSearch", "type": "string" }, { "default": "strict" } ], "description": "

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

\n", "examples": [ "off", "moderate", "strict" ], "title": "Safe search" }, "search_lang": { "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 search language preference. The 2 or more character language code for which the search results are provided." }, "spellcheck": { "default": true, "description": "Whether to spell check the provided query. If the spellchecker 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" }, "ui_lang": { "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." } }, "required": [ "q" ], "title": "NewsSearchParameters", "type": "object" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_NewsSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "News Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/spellcheck/search": { "get": { "description": "\nPublished reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_b5c877b4de0b__any_brave_search_apis_v1_brave_spellcheck_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 spell check country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating spellcheck responses.", "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 spell check country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating spellcheck responses." } }, { "deprecated": false, "description": "The spell check language preference, where potentially the results could come from. The 2 or more character language code for which the spell check search results are provided. This is a just a hint for calculating spell check responses.", "in": "query", "name": "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 spell check language preference, where potentially the results could come from. The 2 or more character language code for which the spell check search results are provided. This is a just a hint for calculating spell check responses." } }, { "deprecated": false, "description": "The phrase to be spell checked. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "in": "query", "name": "q", "required": true, "schema": { "description": "The phrase to be spell checked. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "maxLength": 400, "minLength": 1, "title": "Q", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_b5c877b4de0b__Response762Cca4421D2_SpellCheckSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Spell Check", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "500", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/suggest/search": { "get": { "description": "\nPublished reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_21ef24ae52d8__any_brave_search_apis_v1_brave_suggest_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 number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.", "in": "query", "name": "count", "required": false, "schema": { "default": 5, "description": "The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.", "maximum": 20, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "The suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses.", "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 suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses." } }, { "deprecated": false, "description": "The suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses.", "in": "query", "name": "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 suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses." } }, { "deprecated": false, "description": "The user\u2019s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words.", "in": "query", "name": "q", "required": true, "schema": { "description": "The user\u2019s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words.", "maxLength": 400, "minLength": 1, "title": "The user's suggest search query term.", "type": "string" } }, { "deprecated": false, "description": "Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.", "examples": { "Exclude rich suggestions": { "value": false }, "Include rich suggestions": { "value": true } }, "in": "query", "name": "rich", "required": false, "schema": { "default": false, "description": "Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.", "title": "Rich", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_21ef24ae52d8__Response762Cca4421D2_SuggestSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Suggest", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "500", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/videos/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_21a06d13d0be__get_any_brave_search_apis_v1_brave_videos_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 number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "in": "query", "name": "count", "required": false, "schema": { "default": 20, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" } }, { "deprecated": false, "description": "The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.", "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." } }, { "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": "Include fetch metadata.", "examples": { "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "include_fetch_metadata", "required": false, "schema": { "default": false, "description": "Include fetch metadata.", "examples": [ true, false ], "title": "Include Fetch Metadata", "type": "boolean" } }, { "deprecated": false, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "maximum": 9, "minimum": 0, "title": "Offset", "type": "integer" } }, { "deprecated": false, "description": "Whether to apply search operators.", "examples": { "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\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "in": "query", "name": "q", "required": true, "schema": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "maxLength": 400, "minLength": 1, "title": "Q", "type": "string" } }, { "deprecated": false, "description": "

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

\n", "examples": { "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 search language preference. 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 search language preference. The 2 or more character language code for which the search results are provided." } }, { "deprecated": false, "description": "Whether to spell check the provided query. If the spellchecker 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": { "1": { "value": true }, "2": { "value": false } }, "in": "query", "name": "spellcheck", "required": false, "schema": { "default": true, "description": "Whether to spell check the provided query. If the spellchecker 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": "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." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_21a06d13d0be__Response762Cca4421D2_VideoSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Video Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_252245bec325__post_any_brave_search_apis_v1_brave_videos_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" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "count": { "default": 20, "description": "The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.", "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" }, "country": { "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 search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide." }, "freshness": { "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" }, "include_fetch_metadata": { "default": false, "description": "Include fetch metadata.", "examples": [ true, false ], "title": "Include Fetch Metadata", "type": "boolean" }, "offset": { "default": 0, "description": "The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.", "maximum": 9, "minimum": 0, "title": "Offset", "type": "integer" }, "operators": { "default": true, "description": "Whether to apply search operators.", "examples": [ true, false ], "title": "Operators", "type": "boolean" }, "q": { "description": "The user\u2019s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.", "maxLength": 400, "minLength": 1, "title": "Q", "type": "string" }, "safesearch": { "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" }, "search_lang": { "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 search language preference. The 2 or more character language code for which the search results are provided." }, "spellcheck": { "default": true, "description": "Whether to spell check the provided query. If the spellchecker 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" }, "ui_lang": { "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." } }, "required": [ "q" ], "title": "VideoSearchParameters", "type": "object" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_252245bec325__Response762Cca4421D2_VideoSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Video Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/web/rich": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_79e935d283f3__any_brave_search_apis_v1_brave_web_rich", "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 callback key to use for the rich header", "in": "query", "name": "callback_key", "required": true, "schema": { "description": "The callback key to use for the rich header", "title": "Callback Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_RichHeaderResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Rich Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/brave/web/search": { "get": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_d8ec797afd8b__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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s postal code.", "title": "Postal code" } }, { "deprecated": false, "description": "A code which could be up to three characters, that represent the client\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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": { "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": { "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\u2019s 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\u2019s 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\u2019s 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\u2019s 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": { "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": { "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\u2019s 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\u2019s 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": { "1": { "value": [ "web" ] }, "2": { "value": [ "videos" ] }, "3": { "value": [ "web", "videos" ] } }, "explode": false, "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" }, "style": "form" }, { "deprecated": false, "description": "

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

\n", "examples": { "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": { "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": { "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": { "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": { "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_WebSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Web Search", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/brave/web/search?q=brave+search' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "\nPublished reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "brave_search_9d511fdc48e6__post_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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s postal code.", "title": "Postal code" } }, { "deprecated": false, "description": "A code which could be up to three characters, that represent the client\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s 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\u2019s device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database.", "title": "IANA timezone" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "count": { "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" }, "country": { "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" }, "enable_rich_callback": { "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" }, "extra_snippets": { "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" }, "freshness": { "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" }, "goggles": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Goggles act as a custom re-ranking on top of Brave\u2019s 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" }, "goggles_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "deprecated": true, "description": "Goggles act as a custom re-ranking on top of Brave\u2019s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.", "title": "Goggles id" }, "include_fetch_metadata": { "default": false, "description": "Include fetch metadata.", "examples": [ false, true ], "title": "Include Fetch Metadata", "type": "boolean" }, "offset": { "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" }, "operators": { "default": true, "description": "Whether to apply search operators", "examples": [ true, false ], "title": "Operators", "type": "boolean" }, "q": { "description": "The user\u2019s 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" }, "result_filter": { "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" }, "safesearch": { "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" }, "search_lang": { "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" }, "spellcheck": { "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" }, "summary": { "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" }, "text_decorations": { "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" }, "ui_lang": { "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" }, "units": { "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" } }, "required": [ "q" ], "title": "WebSearchParameters", "type": "object" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_WebSearchApiResponse" } } }, "description": "Successful Response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Web Search", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "5000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.005" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/byteplus/fetch": { "post": { "description": "Fetch a single URL and return clean, structured page content \u2014 title, body text, and publish time. `Url` is required. The response wraps `ResponseMetadata.RequestId` and a `Result` object with the parsed content. Use it to extract full page content for URLs you already have, typically pairing it with `post_byteplus_web_search` results. failed requests are not charged.\n\n\nPublished reference price: $0.0008 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "byteplus_search_84c383f0ef98__post_byteplus_fetch", "requestBody": { "content": { "application/json": { "examples": { "basic": { "summary": "Fetch a page", "value": { "Url": "https://example.com" } } }, "schema": { "properties": { "Url": { "description": "The URL to fetch. Required.", "example": "https://example.com", "type": "string" } }, "required": [ "Url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "summary": "Live gateway 200 response", "value": { "ResponseMetadata": { "Action": "", "Region": "", "RequestId": "20260904155514D7EA140BFD77348BC3FC", "Service": "", "Version": "" }, "Result": { "Data": { "ContentText": "This domain is for use in documentation examples without needing permission. Avoid use in operations.\nLearn more", "PublishTime": 0, "StatusCode": 200, "Title": "Example Domain", "Url": "https://example.com" }, "LogId": "20260904155514D7EA140BFD77348BC3FC" } } } }, "schema": { "properties": { "ResponseMetadata": { "description": "Upstream request metadata.", "properties": { "Action": { "type": "string" }, "Region": { "type": "string" }, "RequestId": { "description": "Unique identifier for this request.", "type": "string" }, "Service": { "type": "string" }, "Version": { "type": "string" } }, "type": "object" }, "Result": { "description": "Fetch result payload.", "properties": { "Data": { "description": "Structured page content.", "properties": { "ContentText": { "description": "Clean body text extracted from the page.", "type": "string" }, "PublishTime": { "description": "Detected publish time as Unix seconds (0 if unknown).", "type": "integer" }, "StatusCode": { "description": "HTTP status code of the fetched page.", "type": "integer" }, "Title": { "description": "Page title.", "type": "string" }, "Url": { "description": "The fetched URL.", "type": "string" } }, "type": "object" }, "LogId": { "description": "Upstream log id (equals ResponseMetadata.RequestId).", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Fetch completed successfully. `Result` holds the structured page content." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "BytePlus Fetch", "tags": [ "byteplus" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/byteplus/fetch \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"Url\": \"https://example.com\"\n}'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "800", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0008" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/byteplus/web-search": { "post": { "description": "Run a real-time web search built for AI agents and return a ranked list of titled results with links and snippets. `Query` is required; narrow the result set with `Count` (\u2264 20), `Filter` (restrict to `Sites` or exclude `BlockHosts`), `Language`, and `TimeRange`. The response wraps `ResponseMetadata.RequestId` and a `Result` list of web results. Use it for RAG retrieval augmentation, competitive/PR monitoring, fact-checking, and content sourcing; pair each result URL with `post_byteplus_fetch` to pull full page content. failed requests are not charged.\n\n\nPublished reference price: $0.0048 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "byteplus_search_b4a9c4ab3c77__post_byteplus_web_search", "requestBody": { "content": { "application/json": { "examples": { "basic": { "summary": "Minimal query", "value": { "Query": "OpenAI news" } }, "filtered": { "summary": "Query with count, domain filter, language and time window", "value": { "Count": 10, "Filter": { "BlockHosts": "reddit.com", "Sites": "openai.com|bytedance.com" }, "Language": "EN", "Query": "OpenAI product launch", "TimeRange": "OneWeek" } } }, "schema": { "properties": { "Count": { "default": 10, "description": "Number of results to return. Optional; default 10, maximum 20.", "example": 10, "maximum": 20, "type": "integer" }, "Filter": { "description": "Optional result filter. Both fields are pipe-separated strings of full domains (max 5 each).", "properties": { "BlockHosts": { "description": "Exclude results from these full domains. Pipe-separated, max 5, e.g. \"reddit.com|quora.com\".", "example": "reddit.com|quora.com", "type": "string" }, "Sites": { "description": "Restrict results to these full domains. Pipe-separated, max 5, e.g. \"bytedance.com|byteplus.com\". (Sending an array returns 10400 Invalid Parameter.)", "example": "bytedance.com|byteplus.com", "type": "string" } }, "type": "object" }, "Language": { "description": "Optional language hint in the upstream format, e.g. EN, ZH-HANS, ZH-HANT.", "example": "EN", "type": "string" }, "Query": { "description": "The search query. Required. Max 400 characters; the upstream engine also effectively caps around 50 words.", "example": "OpenAI news", "maxLength": 400, "type": "string" }, "TimeRange": { "description": "Optional recency window. One of the named windows OneDay / OneWeek / OneMonth / OneYear, or a custom range \"YYYY-MM-DD..YYYY-MM-DD\". Omit for no time filter. NOTE: values like \"week\"/\"month\" are silently ignored upstream.", "example": "OneWeek", "oneOf": [ { "enum": [ "OneDay", "OneWeek", "OneMonth", "OneYear" ], "type": "string" }, { "description": "Custom range, e.g. 2026-08-01..2026-09-01.", "pattern": "^\\d{4}-\\d{2}-\\d{2}\\.\\.\\d{4}-\\d{2}-\\d{2}$", "type": "string" } ] } }, "required": [ "Query" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "summary": "Live gateway 200 response", "value": { "ResponseMetadata": { "Action": "", "Region": "", "RequestId": "20260904155503A787EC832774768DC56F", "Service": "", "Version": "" }, "Result": { "Choices": null, "LogId": "20260904155503A787EC832774768DC56F", "ResultCount": 3, "SearchContext": { "OriginQuery": "OpenAI latest news", "SearchType": "web" }, "TimeCost": 935, "Usage": null, "WebResults": [ { "Id": "19b903d59c017bbb04c7832574500d49", "LogoUrl": "https://p16-bpsearch-sign.ibyteimg.com/...", "PublishTime": "2026-09-03T07:50:20+08:00", "PublishTimeUnix": 1788393020, "SiteName": "OpenAI", "Snippet": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.", "SortId": 1, "Summary": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.", "Title": "OpenAI News | OpenAI", "Url": "https://openai.com/news/" } ] } } } }, "schema": { "properties": { "ResponseMetadata": { "description": "Upstream request metadata.", "properties": { "Action": { "type": "string" }, "Region": { "type": "string" }, "RequestId": { "description": "Unique identifier for this request.", "type": "string" }, "Service": { "type": "string" }, "Version": { "type": "string" } }, "type": "object" }, "Result": { "description": "Search result payload.", "properties": { "Choices": { "description": "Reserved; null unless applicable.", "items": { "type": "object" }, "type": [ "array", "null" ] }, "LogId": { "description": "Upstream log id (equals ResponseMetadata.RequestId).", "type": "string" }, "ResultCount": { "description": "Number of web results returned.", "type": "integer" }, "SearchContext": { "description": "Echo of the resolved query context.", "properties": { "OriginQuery": { "type": "string" }, "SearchType": { "type": "string" } }, "type": "object" }, "TimeCost": { "description": "Upstream processing time in milliseconds.", "type": "integer" }, "Usage": { "description": "Reserved; null unless applicable.", "type": [ "object", "null" ] }, "WebResults": { "description": "Ranked list of web results.", "items": { "properties": { "Id": { "description": "Opaque result id.", "type": "string" }, "LogoUrl": { "description": "Signed site logo URL (time-limited).", "type": "string" }, "PublishTime": { "description": "Publish time in ISO 8601 (may be empty).", "type": "string" }, "PublishTimeUnix": { "description": "Publish time as Unix seconds (0 if unknown).", "type": "integer" }, "SiteName": { "description": "Source site name (may be empty).", "type": "string" }, "Snippet": { "description": "Short text snippet from the page.", "type": "string" }, "SortId": { "description": "1-based rank of the result.", "type": "integer" }, "Summary": { "description": "Longer summary of the page content.", "type": "string" }, "Title": { "description": "Result title.", "type": "string" }, "Url": { "description": "Result URL.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Search completed successfully. `Result` holds the ranked web results." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "BytePlus Web Search", "tags": [ "byteplus" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/byteplus/web-search \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"Query\": \"OpenAI news\"\n}'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "4800", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0048" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/edinet/documents.json": { "get": { "description": "{\"methods\":[{\"methodType\":\"GET\",\"methodDesc\":\"Query the EDINET filing list for a given file date. Returns metadata only when type=1, or metadata plus filing results when type=2.\",\"requestParams\":[{\"paramName\":\"date\",\"paramType\":\"query\",\"required\":true,\"desc\":\"File date in YYYY-MM-DD format.\"},{\"paramName\":\"type\",\"paramType\":\"query\",\"desc\":\"Response mode: 1 for metadata only, 2 for metadata plus filing list. Defaults to 1 when omitted.\"},{\"paramName\":\"Subscription-Key\",\"paramType\":\"query\",\"required\":true,\"desc\":\"EDINET API key passed as a query parameter.\"}],\"responseParams\":[{\"paramName\":\"metadata\",\"desc\":\"Metadata object with title, request parameter echo, result count, processDateTime, status, and message.\"},{\"paramName\":\"results\",\"desc\":\"Array of filing document objects when type=2, including fields such as seqNumber, docID, filerName, docTypeCode, submitDateTime, and file availability flags.\"}]}]}\n\n\nPublished reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "edinet_e79bbb96e27a__get_edinet_documents", "parameters": [ { "description": "File date in YYYY-MM-DD format.", "in": "query", "name": "date", "required": true, "schema": { "examples": [ "2026-07-23" ], "format": "date", "type": "string" } }, { "description": "Response mode: 1 for metadata only, 2 for metadata plus filing list.", "in": "query", "name": "type", "required": false, "schema": { "default": 1, "enum": [ 1, 2 ], "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "metadata": { "description": "Metadata object with title, request parameter echo, result count, processDateTime, status, and message.", "type": "object" }, "results": { "description": "Filing document objects when type=2.", "items": { "properties": { "docID": { "type": "string" }, "docTypeCode": { "type": "string" }, "filerName": { "type": "string" }, "seqNumber": { "type": "integer" }, "submitDateTime": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "EDINET document-list response." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Document List API", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/edinet/documents.json?date=2026-07-23' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "10", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00001" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/company/facts": { "get": { "description": "Get company facts for a ticker.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_73a92c5f25db__get_financial_company_facts", "parameters": [ { "description": "The CIK of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_73a92c5f25db__Response7B6Efb3B471D_CompanyFactsResponse" } } }, "description": "Company facts response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Company Facts", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/company/facts/ticker": { "get": { "description": "Get company facts for a ticker.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_d4afaa4edad4__any_financial_apis_v1_financial_company_facts_ticker", "parameters": [ { "description": "The CIK of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_d4afaa4edad4__Response7B6Efb3B471D_CompanyFactsResponse" } } }, "description": "Company facts response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Company Facts", "tags": [ "Zero" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/earnings": { "get": { "description": "Get the most recent earnings snapshot for a ticker. Optional change fields are returned only when available.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_1d3bf6d10a84__get_financial_earnings", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Number of most-recent **report periods** worth of filings to return, sorted by `(report_period DESC, filing_date ASC)`. The number of entries returned may exceed `limit` when a recent period has both an 8-K and a 10-Q / 10-K. Values above 40 are clamped to 40. Non-positive or non-integer values return 400. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "required": false, "schema": { "default": 1, "maximum": 40, "minimum": 1, "type": "integer" } }, { "description": "The ticker symbol (e.g. `AAPL`).", "in": "query", "name": "ticker", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsResponse" } } }, "description": "Earnings response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Earnings Data", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/filings": { "get": { "description": "Get SEC filings for a company.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_e88a4a544406__get_financial_filings", "parameters": [ { "description": "The Central Index Key (CIK) of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Filter by one or more filing types. Repeat the query parameter to pass multiple values (e.g. filing_type=10-Q&filing_type=10-K).", "explode": true, "in": "query", "name": "filing_type", "required": false, "schema": { "items": { "enum": [ "10-K", "10-Q", "20-F", "6-K", "8-K" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The maximum number of filings to return (default: 10). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.\n\nProvider reference (supplier schema): `{\"default\":10,\"minimum\":1,\"type\":\"integer\"}`.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_e88a4a544406__Response7B6Efb3B471D_FilingsResponse" } } }, "description": "SEC filings response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Company SEC Filings", "tags": [ "Two" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/filings/items": { "get": { "description": "Get the raw text Items from an SEC filing.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_e8bcab5539e3__get_financial_filings_items", "parameters": [ { "description": "The accession number of the filing if 8-K.", "in": "query", "name": "accession_number", "required": false, "schema": { "type": "string" } }, { "description": "The type of filing.", "in": "query", "name": "filing_type", "required": true, "schema": { "enum": [ "10-K", "10-Q", "8-K" ], "type": "string" } }, { "description": "Whether to include the raw text from linked exhibits. Only applicable for 8-K filings. When true, exhibit objects will include the 'text' field containing the full exhibit content.", "in": "query", "name": "include_exhibits", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "The item to get.", "in": "query", "name": "item", "required": false, "schema": { "enum": [ "Item-1", "Item-1A", "Item-1B", "Item-2", "Item-3", "Item-4", "Item-5", "Item-6", "Item-7", "Item-7A", "Item-8", "Item-9", "Item-9A", "Item-9B", "Item-10", "Item-11", "Item-12", "Item-13", "Item-14", "Item-15", "Item-16", "Item-1.01", "Item-1.02", "Item-1.03", "Item-1.04", "Item-2.01", "Item-2.02", "Item-2.03", "Item-2.04", "Item-2.05", "Item-2.06", "Item-3.01", "Item-3.02", "Item-3.03", "Item-4.01", "Item-4.02", "Item-5.01", "Item-5.02", "Item-5.03", "Item-5.04", "Item-5.05", "Item-5.06", "Item-5.07", "Item-5.08", "Item-6.01", "Item-6.02", "Item-6.03", "Item-6.04", "Item-6.05", "Item-7.01", "Item-8.01", "Item-9.01" ], "type": "string" } }, { "description": "The quarter of the filing if 10-Q.", "in": "query", "name": "quarter", "required": false, "schema": { "type": "integer" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": true, "schema": { "type": "string" } }, { "description": "The year of the filing.", "in": "query", "name": "year", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_e8bcab5539e3__Response7B6Efb3B471D_FilingItemsResponse" } } }, "description": "SEC filing items response" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_e8bcab5539e3__Response7B6Efb3B471D_FilingItemsAccepted" } } }, "description": "The filing is still being prepared. Poll the result_url from the response body to retrieve the result. You are not billed for this response." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get SEC Filing Items", "tags": [ "Two" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financial-metrics": { "get": { "description": "Get financial metrics for a ticker, including valuation, profitability, efficiency, liquidity, leverage, growth, and per share metrics.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_f7306fceaf62__get_financial_financial_metrics", "parameters": [ { "description": "The Central Index Key (CIK) of the company. Can be used instead of ticker.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's metrics. Price-based values (market cap, enterprise value, valuation ratios, dividend yield) are not yet available for UK tickers.", "in": "query", "name": "exchange", "required": false, "schema": { "enum": [ "LSE" ], "type": "string" } }, { "description": "Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_gt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_lt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`.", "in": "query", "name": "isin", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of results to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "The time period for the financial data.", "in": "query", "name": "period", "required": true, "schema": { "enum": [ "annual", "quarterly", "ttm" ], "type": "string" } }, { "description": "Filter by exact report period date in YYYY-MM-DD format.", "in": "query", "name": "report_period", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period greater than date in YYYY-MM-DD format.", "in": "query", "name": "report_period_gt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period greater than or equal to date in YYYY-MM-DD format.", "in": "query", "name": "report_period_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period less than date in YYYY-MM-DD format.", "in": "query", "name": "report_period_lt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period less than or equal to date in YYYY-MM-DD format.", "in": "query", "name": "report_period_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ticker symbol of the company. Required if cik is not provided.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_f7306fceaf62__Response7B6Efb3B471D_FinancialMetricsResponse" } } }, "description": "The historical financial metrics and ratios for a ticker" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Financial Metrics", "tags": [ "Two" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financial-metrics/snapshot": { "get": { "description": "Get the real-time financial metrics snapshot for a stock, including valuation ratios, profitability, efficiency, liquidity, leverage, growth, and per share metrics.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_4ac6c35a9985__get_financial_financial_metrics_snapshot", "parameters": [ { "description": "The Central Index Key (CIK) of the company. Can be used instead of ticker.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's metrics. Price-based values (market cap, enterprise value, valuation ratios, dividend yield) are not yet available for UK tickers.", "in": "query", "name": "exchange", "required": false, "schema": { "enum": [ "LSE" ], "type": "string" } }, { "description": "The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`.", "in": "query", "name": "isin", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol of the company.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_4ac6c35a9985__Response7B6Efb3B471D_FinancialMetricSnapshotResponse" } } }, "description": "Financial metrics snapshot response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Financial Metrics Snapshot", "tags": [ "Two" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financials": { "get": { "description": "Get all financial statements for a ticker.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_bbf410fc1397__get_financial_financials", "parameters": [ { "description": "The Central Index Key (CIK) of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's statements.", "in": "query", "name": "exchange", "required": false, "schema": { "enum": [ "LSE" ], "type": "string" } }, { "description": "Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_gt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_lt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`.", "in": "query", "name": "isin", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of financial statements to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } }, { "description": "The time period of the financial statements.", "in": "query", "name": "period", "required": true, "schema": { "enum": [ "annual", "quarterly", "ttm" ], "type": "string" } }, { "description": "Filter by exact report period date in YYYY-MM-DD format.", "in": "query", "name": "report_period", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period greater than date in YYYY-MM-DD format.", "in": "query", "name": "report_period_gt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period greater than or equal to date in YYYY-MM-DD format.", "in": "query", "name": "report_period_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period less than date in YYYY-MM-DD format.", "in": "query", "name": "report_period_lt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period less than or equal to date in YYYY-MM-DD format.", "in": "query", "name": "report_period_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ticker symbol. Required if cik or isin is not provided.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_bbf410fc1397__Response7B6Efb3B471D_FinancialsResponse" } } }, "description": "Financial statements response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Financial Statements", "tags": [ "Ten" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financials/balance-sheets": { "get": { "description": "Get balance sheets for a ticker.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_2fb33f4d98b5__get_financial_financials_balance_sheets", "parameters": [ { "description": "The Central Index Key (CIK) of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's statements.", "in": "query", "name": "exchange", "required": false, "schema": { "enum": [ "LSE" ], "type": "string" } }, { "description": "Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_gt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_gte", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_lt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_lte", "required": false, "schema": { "type": "string" } }, { "description": "The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`.", "in": "query", "name": "isin", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of balance sheets to return This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.\n\nProvider reference (supplier schema): `{\"format\":\"int32\",\"type\":\"integer\"}`.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "The time period of the balance sheets.\n\nProvider reference (supplier schema): `{\"enum\":[\"annual\",\"quarterly\",\"ttm\"],\"type\":\"string\"}`.", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "Filter by exact report period date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period greater than date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_gt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period greater than or equal to date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_gte", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period less than date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_lt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period less than or equal to date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_lte", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol. Required if cik or isin is not provided.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_2fb33f4d98b5__Response7B6Efb3B471D_BalanceSheetResponse" } } }, "description": "Balance sheets response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Balance Sheets", "tags": [ "Four" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financials/cash-flow-statements": { "get": { "description": "Get cash flow statements for a ticker.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_6bac5d996461__get_financial_financials_cash_flow_statements", "parameters": [ { "description": "The Central Index Key (CIK) of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's statements.", "in": "query", "name": "exchange", "required": false, "schema": { "enum": [ "LSE" ], "type": "string" } }, { "description": "Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_gt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_lt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded.", "in": "query", "name": "filing_date_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`.", "in": "query", "name": "isin", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of cash flow statements to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } }, { "description": "The time period of the cash flow statements.", "in": "query", "name": "period", "required": true, "schema": { "enum": [ "annual", "quarterly", "ttm" ], "type": "string" } }, { "description": "Filter by exact report period date in YYYY-MM-DD format.", "in": "query", "name": "report_period", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period greater than date in YYYY-MM-DD format.", "in": "query", "name": "report_period_gt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period greater than or equal to date in YYYY-MM-DD format.", "in": "query", "name": "report_period_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period less than date in YYYY-MM-DD format.", "in": "query", "name": "report_period_lt", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Filter by report period less than or equal to date in YYYY-MM-DD format.", "in": "query", "name": "report_period_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ticker symbol. Required if cik or isin is not provided.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_6bac5d996461__Response7B6Efb3B471D_CashFlowStatementResponse" } } }, "description": "Cash flow statements response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Cash Flow Statements", "tags": [ "Four" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financials/income-statements": { "get": { "description": "Get income statements for a ticker.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_264348f340ef__get_financial_financials_income_statements", "parameters": [ { "description": "The Central Index Key (CIK) of the company.", "in": "query", "name": "cik", "required": false, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's statements.", "in": "query", "name": "exchange", "required": false, "schema": { "enum": [ "LSE" ], "type": "string" } }, { "description": "Filter by exact SEC filing date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date greater than date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_gt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date greater than or equal to date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_gte", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date less than date in YYYY-MM-DD format. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_lt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC filing date less than or equal to date in YYYY-MM-DD format. Useful for point-in-time queries: returns only data that was publicly filed by the given date. Rows without a known filing date are excluded.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_lte", "required": false, "schema": { "type": "string" } }, { "description": "The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`.", "in": "query", "name": "isin", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of income statements to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.\n\nProvider reference (supplier schema): `{\"format\":\"int32\",\"type\":\"integer\"}`.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "The time period of the income statements.\n\nProvider reference (supplier schema): `{\"enum\":[\"annual\",\"quarterly\",\"ttm\"],\"type\":\"string\"}`.", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "Filter by exact report period date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period greater than date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_gt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period greater than or equal to date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_gte", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period less than date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_lt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by report period less than or equal to date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "report_period_lte", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol. Required if cik or isin is not provided.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_264348f340ef__Response7B6Efb3B471D_IncomeStatementResponse" } } }, "description": "Income statements response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Income Statements", "tags": [ "Four" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financials/search/line-items": { "post": { "description": "Search for specific financial metrics across income statements, balance sheets, and cash flow statements for a list of tickers.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_c38f482ced2d__post_financial_financials_search_line_items", "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 1, "description": "The maximum number of results to return.", "minimum": 1, "type": "integer" }, "line_items": { "description": "An array of line items to apply to the search.", "items": { "description": "The financial metric to search for.", "type": "string" }, "minItems": 1, "type": "array" }, "period": { "default": "ttm", "description": "The time period for the financial data.", "enum": [ "annual", "quarterly", "ttm" ], "type": "string" }, "tickers": { "description": "An array of tickers to apply to the search.", "items": { "description": "The tickers to search for.", "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "line_items", "tickers" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_c38f482ced2d__Response7B6Efb3B471D_FinancialsSearchResponse" } } }, "description": "Successful search response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Search Financial Line Items", "tags": [ "One" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/financials/search/screener": { "post": { "description": "Search for stocks by filtering across financial metrics from income statements, balance sheets, and cash flow statements.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_3790ccc3be34__post_financial_financials_search_screener", "requestBody": { "content": { "application/json": { "schema": { "properties": { "filters": { "description": "An array of filter objects to apply to the search.", "items": { "properties": { "field": { "description": "The criteria to filter on. For financial metric fields, use 'gt', 'lt', 'gte', 'lte', 'eq' operators. For 'ticker' and 'cik' fields, use the 'in' operator to filter against multiple values.", "type": "string" }, "operator": { "description": "The comparison operator. The 'in' operator can only be used with a field value of 'ticker' or 'cik' and lets you filter against multiple values.", "enum": [ "gt", "lt", "gte", "lte", "eq", "in" ], "type": "string" }, "value": { "oneOf": [ { "description": "The value to compare against for single-value operators (gt, lt, gte, lte, eq)", "type": "number" }, { "description": "Array of ticker or cik values to compare against when using the 'in' operator", "items": { "type": "string" }, "type": "array" } ] } }, "required": [ "field", "operator", "value" ], "type": "object" }, "minItems": 1, "type": "array" }, "limit": { "default": 10, "description": "The maximum number of results to return.", "minimum": 1, "type": "integer" } }, "required": [ "filters" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_3790ccc3be34__Response7B6Efb3B471D_FinancialsSearchResponse" } } }, "description": "Successful search response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Search Stock Financials", "tags": [ "One" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/insider-trades": { "get": { "description": "Get insider trades like buys and sells for a ticker by a company insider.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_8fde0fab75ba__get_financial_insider_trades", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Filter by exact filing date in YYYY-MM-DD format.\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date", "required": false, "schema": { "type": "string" } }, { "description": "Filter by filing date greater than this date (YYYY-MM-DD).\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_gt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by filing date greater than or equal to this date (YYYY-MM-DD).\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_gte", "required": false, "schema": { "type": "string" } }, { "description": "Filter by filing date less than this date (YYYY-MM-DD).\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_lt", "required": false, "schema": { "type": "string" } }, { "description": "Filter by filing date less than or equal to this date (YYYY-MM-DD).\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "filing_date_lte", "required": false, "schema": { "type": "string" } }, { "description": "Filter by SEC form type: 4 for trades, 5 for annual statements (or their amendments 4/A, 5/A).", "in": "query", "name": "form_type", "required": false, "schema": { "enum": [ "4", "4/A", "5", "5/A" ], "type": "string" } }, { "description": "The maximum number of transactions to return (default: 10). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.\n\nProvider reference (supplier schema): `{\"default\":10,\"type\":\"integer\"}`.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "Filter by insider name (e.g., 'Jen Hsun Huang'). Use the /insider-trades/names endpoint to get available names for a ticker.", "in": "query", "name": "name", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol of the company.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } }, { "description": "Filter by transaction type (e.g., 'Open market sale', 'Gift'). Use the /insider-trades/transaction-types endpoint to get available types.", "in": "query", "name": "transaction_type", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_8fde0fab75ba__Response7B6Efb3B471D_InsiderTradesResponse" } } }, "description": "Insider trades response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Insider Trades", "tags": [ "Two" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/kpi/guidance": { "get": { "description": "Get structured forward guidance from earnings releases. Returns ranges, point estimates, and directional signals.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_74626c880524__any_financial_apis_v1_financial_kpi_guidance", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "required": false, "schema": { "default": 4, "maximum": 50, "type": "integer" } }, { "description": "Filter to a specific metric.", "in": "query", "name": "metric_name", "required": false, "schema": { "type": "string" } }, { "description": "Filter by period type: quarterly or annual.", "in": "query", "name": "period", "required": false, "schema": { "default": "quarterly", "enum": [ "quarterly", "annual" ], "type": "string" } }, { "description": "Only return guidance on or after this date (YYYY-MM-DD).", "in": "query", "name": "report_period_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return guidance on or before this date (YYYY-MM-DD).", "in": "query", "name": "report_period_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_74626c880524__Response7B6Efb3B471D_KPIGuidanceResponse" } } }, "description": "Guidance response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Guidance", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/kpi/metrics": { "get": { "description": "Get sector-specific operational KPIs for a ticker. Includes metrics like load factor, CET1 ratio, same-store sales, FFO per share, and more. Sourced from SEC 8-K earnings releases.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_d8a477b1ae21__any_financial_apis_v1_financial_kpi_metrics", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Number of periods to return. Returns all metrics for the N most recent periods. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "required": false, "schema": { "default": 4, "maximum": 50, "type": "integer" } }, { "description": "Filter to a specific metric (e.g., load_factor, cet1_ratio).", "in": "query", "name": "metric_name", "required": false, "schema": { "type": "string" } }, { "description": "Filter by period type: quarterly or annual.", "in": "query", "name": "period", "required": false, "schema": { "default": "quarterly", "enum": [ "quarterly", "annual" ], "type": "string" } }, { "description": "Only return metrics on or after this date (YYYY-MM-DD).", "in": "query", "name": "report_period_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return metrics on or before this date (YYYY-MM-DD).", "in": "query", "name": "report_period_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_d8a477b1ae21__Response7B6Efb3B471D_KPIMetricsResponse" } } }, "description": "KPI metrics response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Metrics", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/kpi/non-gaap": { "get": { "description": "Get non-GAAP financial metrics with GAAP equivalents and key adjustments.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_da1d41c0cf88__any_financial_apis_v1_financial_kpi_non_gaap", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Number of periods to return. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.", "in": "query", "name": "limit", "required": false, "schema": { "default": 4, "maximum": 50, "type": "integer" } }, { "description": "Filter to a specific metric.", "in": "query", "name": "metric_name", "required": false, "schema": { "type": "string" } }, { "description": "Filter by period type: quarterly or annual.", "in": "query", "name": "period", "required": false, "schema": { "default": "quarterly", "enum": [ "quarterly", "annual" ], "type": "string" } }, { "description": "Only return metrics on or after this date (YYYY-MM-DD).", "in": "query", "name": "report_period_gte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Only return metrics on or before this date (YYYY-MM-DD).", "in": "query", "name": "report_period_lte", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "The ticker symbol.", "in": "query", "name": "ticker", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_da1d41c0cf88__Response7B6Efb3B471D_KPINonGAAPResponse" } } }, "description": "Non-GAAP metrics response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Non-GAAP Metrics", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/macro/interest-rates": { "get": { "description": "The daily policy rate of one central bank: one row per calendar day, newest first, 10 rows per page. A rate change appears on the first day the new rate is in effect. For the Federal Reserve the rate is the midpoint of the target range.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_37506d2d17c9__get_financial_macro_interest_rates", "parameters": [ { "description": "The central bank code, e.g. FED, ECB, BOJ. Use the /macro/interest-rates/banks endpoint to get the list of available banks.", "in": "query", "name": "bank", "required": true, "schema": { "type": "string" } }, { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The last date to return, inclusive, in YYYY-MM-DD format. Defaults to today.", "in": "query", "name": "end_date", "required": false, "schema": { "type": "string" } }, { "description": "The first date to return, inclusive, in YYYY-MM-DD format. Defaults to five years before end_date when both dates are omitted; omit it with an end_date to get all available history through that date.", "in": "query", "name": "start_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_37506d2d17c9__Response7B6Efb3B471D_InterestRatesResponse" } } }, "description": "Interest rates response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Historical Interest Rates", "tags": [ "Zero" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/macro/interest-rates/snapshot": { "get": { "description": "The newest published policy rate of every central bank we cover, one row per bank with the date it is in effect. Pass bank to get one bank only.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_6ef62a0c5a7d__get_financial_macro_interest_rates_snapshot", "parameters": [ { "description": "Optional central bank code (e.g., FED, ECB, BOJ) to return one bank only. Use the /macro/interest-rates/banks endpoint to get a list of available banks.", "in": "query", "name": "bank", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_6ef62a0c5a7d__Response7B6Efb3B471D_InterestRatesResponse" } } }, "description": "Interest rates snapshot response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Latest Interest Rates", "tags": [ "Zero" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/news": { "get": { "description": "Get recent news articles for a specific company or the broad market. Pass a ticker for company-specific news, or omit the ticker for general market news.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_2c987cdacfbb__get_financial_news", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of news articles to return (default: 5, max: 10). This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.\n\nProvider reference (supplier schema): `{\"default\":5,\"maximum\":10,\"type\":\"integer\"}`.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "The ticker symbol of the company. Omit for broad market news.", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_2c987cdacfbb__Response7B6Efb3B471D_NewsResponse" } } }, "description": "News articles response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Company News", "tags": [ "Two" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/prices": { "get": { "description": "Get end-of-day (EOD) historical price data for stocks.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_3d46c2d9901e__get_financial_prices", "parameters": [ { "description": "Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The end date for the price data (format: YYYY-MM-DD).\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "end_date", "required": false, "schema": { "type": "string" } }, { "description": "The time interval for the price data.\n\nProvider reference (supplier schema): `{\"enum\":[\"day\",\"week\",\"month\",\"year\"],\"type\":\"string\"}`.", "in": "query", "name": "interval", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "interval_multiplier", "required": false, "schema": { "type": "string" } }, { "description": "The start date for the price data (format: YYYY-MM-DD).\n\nProvider reference (supplier schema): `{\"format\":\"date\",\"type\":\"string\"}`.", "in": "query", "name": "start_date", "required": false, "schema": { "type": "string" } }, { "description": "The stock ticker symbol (e.g. AAPL, MSFT).", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_3d46c2d9901e__Response7B6Efb3B471D_PricesResponse" } } }, "description": "Price data response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Historical Stock Prices", "tags": [ "One" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/financial/prices/snapshot": { "get": { "description": "Get the real-time price snapshot for a stock, including the current price, day change, and day change percent.\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "financial_c14b4093f514__get_financial_prices_snapshot", "parameters": [ { "description": "The stock ticker symbol (e.g. AAPL, MSFT).", "in": "query", "name": "ticker", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/financial_c14b4093f514__Response7B6Efb3B471D_PriceSnapshotResponse" } } }, "description": "Price snapshot response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Stock Price Snapshot", "tags": [ "One" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/kalshi/markets": { "get": { "description": "\u9ed8\u8ba4\u4ef7\u683c\u914d\u7f6e\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "kalshi_unauthorized_4c4ca4fdc8b8__get_kalshi_markets", "parameters": [ { "description": "Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.", "in": "query", "name": "cursor", "schema": { "type": "string", "x-go-type-skip-optional-pointer": true } }, { "description": "Event ticker to filter by. Only a single event ticker is supported.", "in": "query", "name": "event_ticker", "schema": { "type": "string", "x-go-type-skip-optional-pointer": true } }, { "description": "Number of results per page. Defaults to 100. Maximum value is 1000.", "in": "query", "name": "limit", "schema": { "default": 100, "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer", "x-oapi-codegen-extra-tags": { "validate": "omitempty,gte=0,lte=1000" } } }, { "description": "Filter items that close before this Unix timestamp", "in": "query", "name": "max_close_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter items that created before this Unix timestamp", "in": "query", "name": "max_created_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter items that settled before this Unix timestamp", "in": "query", "name": "max_settled_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Return markets with metadata updated at or before this Unix timestamp (in seconds). Tracks non-trading changes only. May be combined with min_updated_ts and mve_filter=exclude. May also be combined with series_ticker, which requires mve_filter=exclude. Incompatible with other filters.", "in": "query", "name": "max_updated_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter items that close after this Unix timestamp", "in": "query", "name": "min_close_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter items that created after this Unix timestamp", "in": "query", "name": "min_created_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter items that settled after this Unix timestamp", "in": "query", "name": "min_settled_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Return markets with metadata updated later than this Unix timestamp (in seconds). Tracks non-trading changes only. May be combined with max_updated_ts and mve_filter=exclude. May also be combined with series_ticker, which requires mve_filter=exclude. Incompatible with other filters.", "in": "query", "name": "min_updated_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter by multivariate events (combos). 'only' returns only multivariate events, 'exclude' excludes multivariate events.", "in": "query", "name": "mve_filter", "schema": { "enum": [ "only", "exclude" ], "type": "string" } }, { "description": "Filter by series ticker", "in": "query", "name": "series_ticker", "schema": { "type": "string", "x-go-type-skip-optional-pointer": true } }, { "description": "Filter by market status. Leave empty to return markets with any status.", "in": "query", "name": "status", "schema": { "enum": [ "unopened", "open", "paused", "closed", "settled" ], "type": "string" } }, { "description": "Filter by specific market tickers. Comma-separated list of market tickers to retrieve.", "in": "query", "name": "tickers", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_GetMarketsResponse" } } }, "description": "Markets retrieved successfully" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Kalshi Markets", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/kalshi/markets/{ticker}": { "get": { "description": "\u9ed8\u8ba4\u4ef7\u683c\u914d\u7f6e\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "kalshi_unauthorized_9ba02631e218__any_kalshi_unauthorized_apis_v1_kalshi_markets_ticker", "parameters": [ { "description": "Market ticker", "in": "path", "name": "ticker", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_GetMarketResponse" } } }, "description": "Market retrieved successfully" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Market Price", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/kalshi/markets/{ticker}/orderbook": { "get": { "description": "\u9ed8\u8ba4\u4ef7\u683c\u914d\u7f6e\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "kalshi_unauthorized_691efcfc4aae__any_kalshi_unauthorized_apis_v1_kalshi_markets_ti_7bc540", "parameters": [ { "description": "Market ticker", "in": "path", "name": "ticker", "required": true, "schema": { "type": "string" } }, { "description": "Depth of the orderbook to retrieve (0 or negative means all levels, 1-100 for specific depth)", "in": "query", "name": "depth", "required": false, "schema": { "default": 0, "maximum": 100, "minimum": 0, "type": "integer" }, "x-oapi-codegen-extra-tags": { "validate": "omitempty,min=0,max=100" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_GetMarketOrderbookResponse" } } }, "description": "Orderbook retrieved successfully" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Kalshi Market OrderBook", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/kalshi/trades": { "get": { "description": "\u9ed8\u8ba4\u4ef7\u683c\u914d\u7f6e\n\n\nPublished reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "kalshi_unauthorized_8fe5edad1cda__get_kalshi_trades", "parameters": [ { "description": "Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.", "in": "query", "name": "cursor", "schema": { "type": "string", "x-go-type-skip-optional-pointer": true } }, { "description": "Filter trades by whether they are block trades. Omit to return all trades. Set to `true` to return only block trades. Set to `false` to return only non-block trades.\n", "in": "query", "name": "is_block_trade", "schema": { "type": "boolean" } }, { "description": "Number of results per page. Defaults to 100. Maximum value is 1000.", "in": "query", "name": "limit", "schema": { "default": 100, "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer", "x-oapi-codegen-extra-tags": { "validate": "omitempty,gte=0,lte=1000" } } }, { "description": "Filter items before this Unix timestamp", "in": "query", "name": "max_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter items after this Unix timestamp", "in": "query", "name": "min_ts", "schema": { "format": "int64", "type": "integer" } }, { "description": "Filter by market ticker", "in": "query", "name": "ticker", "schema": { "type": "string", "x-go-type-skip-optional-pointer": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_GetTradesResponse" } } }, "description": "Trades retrieved successfully" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get Kalshi Trades", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.02" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/openmeteo/elevation": { "get": { "description": "Terrain elevation (DEM) by coordinates.\n\n\nPublished reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "openmeteo_e3d85f85e950__get_openmeteo_elevation", "parameters": [ { "description": "WGS84 latitude, or a comma-separated list of up to 100 latitudes.", "in": "query", "name": "latitude", "required": true, "schema": { "example": "52.52,48.85", "type": "string" } }, { "description": "WGS84 longitude, or a comma-separated list of up to 100 longitudes (positions aligned with `latitude`).", "in": "query", "name": "longitude", "required": true, "schema": { "example": "13.41,2.35", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "elevation": [ 38.0, 35.0 ] }, "schema": { "type": "object" } } }, "description": "Elevation in meters for each requested coordinate." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Open-Meteo Elevation", "tags": [ "openmeteo" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/openmeteo/elevation?latitude=52.52%2C48.85&longitude=13.41%2C2.35' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "100", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0001" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/openmeteo/forecast": { "get": { "description": "16-day hourly/daily/current weather forecast by coordinates.\n\n\nPublished reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "openmeteo_91962a870057__get_openmeteo_forecast", "parameters": [ { "description": "Grid-cell preference for the coordinate. Default `land`.", "in": "query", "name": "cell_selection", "required": false, "schema": { "default": "land", "enum": [ "land", "sea", "nearest" ], "type": "string" } }, { "description": "Comma-separated list of current-condition variables to return. Common values: `temperature_2m`, `relative_humidity_2m`, `apparent_temperature`, `is_day`, `precipitation`, `weather_code`, `wind_speed_10m`, `wind_direction_10m`.", "in": "query", "name": "current", "required": false, "schema": { "example": "temperature_2m,weather_code", "type": "string" } }, { "description": "Comma-separated list of daily aggregation variables to return. Requires `timezone`. Common values: `temperature_2m_max`, `temperature_2m_min`, `temperature_2m_mean`, `precipitation_sum`, `rain_sum`, `snowfall_sum`, `weather_code`, `sunrise`, `sunset`, `sunshine_duration`, `wind_speed_10m_max`, `uv_index_max`.", "in": "query", "name": "daily", "required": false, "schema": { "example": "temperature_2m_max,temperature_2m_min,precipitation_sum", "type": "string" } }, { "description": "Manual elevation (meters) for statistical downscaling. Defaults to a 90m DEM. Use `nan` to disable downscaling.", "in": "query", "name": "elevation", "required": false, "schema": { "example": "38", "type": "string" } }, { "description": "End of the interval, `yyyy-mm-dd` (ISO 8601).", "in": "query", "name": "end_date", "required": false, "schema": { "example": "2024-01-07", "format": "date", "type": "string" } }, { "description": "Number of forecast days to return (0-16). Default 7.", "in": "query", "name": "forecast_days", "required": false, "schema": { "default": 7, "example": 7, "type": "integer" } }, { "description": "Limit the forecast to a given number of hours from now.", "in": "query", "name": "forecast_hours", "required": false, "schema": { "type": "integer" } }, { "description": "Comma-separated list of hourly variables to return. Common values: `temperature_2m`, `relative_humidity_2m`, `dew_point_2m`, `apparent_temperature`, `precipitation`, `rain`, `showers`, `snowfall`, `weather_code`, `pressure_msl`, `cloud_cover`, `wind_speed_10m`, `wind_direction_10m`, `wind_gusts_10m`, `shortwave_radiation`, `visibility`.", "in": "query", "name": "hourly", "required": false, "schema": { "example": "temperature_2m,precipitation,wind_speed_10m", "type": "string" } }, { "description": "WGS84 latitude of the location. Multiple coordinates can be comma-separated.", "in": "query", "name": "latitude", "required": true, "schema": { "example": "52.52", "type": "string" } }, { "description": "WGS84 longitude of the location (negative for the Americas). Multiple coordinates can be comma-separated.", "in": "query", "name": "longitude", "required": true, "schema": { "example": "13.41", "type": "string" } }, { "description": "Comma-separated 15-minutely variables (Central Europe & North America high-resolution models only).", "in": "query", "name": "minutely_15", "required": false, "schema": { "example": "temperature_2m,precipitation", "type": "string" } }, { "description": "Comma-separated forecast models to use. Default `auto` selects the best model mix per location.", "in": "query", "name": "models", "required": false, "schema": { "example": "auto", "type": "string" } }, { "description": "Number of past days to include (0-92). Default 0.", "in": "query", "name": "past_days", "required": false, "schema": { "default": 0, "type": "integer" } }, { "description": "Include a given number of past hours.", "in": "query", "name": "past_hours", "required": false, "schema": { "type": "integer" } }, { "description": "Precipitation unit. Default `mm`.", "in": "query", "name": "precipitation_unit", "required": false, "schema": { "default": "mm", "enum": [ "mm", "inch" ], "type": "string" } }, { "description": "Start of the interval, `yyyy-mm-dd` (ISO 8601).", "in": "query", "name": "start_date", "required": false, "schema": { "example": "2024-01-01", "format": "date", "type": "string" } }, { "description": "Temperature unit. Default `celsius`.", "in": "query", "name": "temperature_unit", "required": false, "schema": { "default": "celsius", "enum": [ "celsius", "fahrenheit" ], "type": "string" } }, { "description": "Time output format. Default `iso8601`.", "in": "query", "name": "timeformat", "required": false, "schema": { "default": "iso8601", "enum": [ "iso8601", "unixtime" ], "type": "string" } }, { "description": "IANA time zone name (e.g. `Europe/Berlin`) or `auto` to resolve from coordinates. Defaults to `GMT`.", "in": "query", "name": "timezone", "required": false, "schema": { "example": "Europe/Berlin", "type": "string" } }, { "description": "Wind speed unit. Default `kmh`.", "in": "query", "name": "wind_speed_unit", "required": false, "schema": { "default": "kmh", "enum": [ "kmh", "ms", "mph", "kn" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "current": { "interval": 900, "temperature_2m": 4.5, "time": "2024-01-01T12:00", "weather_code": 3 }, "current_units": { "interval": "seconds", "temperature_2m": "\u00b0C", "time": "iso8601", "weather_code": "wmo code" }, "daily": { "precipitation_sum": [ 0.4 ], "temperature_2m_max": [ 5.2 ], "temperature_2m_min": [ 1.1 ], "time": [ "2024-01-01" ] }, "daily_units": { "precipitation_sum": "mm", "temperature_2m_max": "\u00b0C", "temperature_2m_min": "\u00b0C", "time": "iso8601" }, "elevation": 38.0, "generationtime_ms": 0.19, "hourly": { "precipitation": [ 0.0, 0.1 ], "temperature_2m": [ 2.1, 1.9 ], "time": [ "2024-01-01T00:00", "2024-01-01T01:00" ], "wind_speed_10m": [ 11.2, 10.4 ] }, "hourly_units": { "precipitation": "mm", "temperature_2m": "\u00b0C", "time": "iso8601", "wind_speed_10m": "km/h" }, "latitude": 52.52, "longitude": 13.419998, "timezone": "Europe/Berlin", "timezone_abbreviation": "CEST", "utc_offset_seconds": 7200 }, "schema": { "type": "object" } } }, "description": "Requested weather forecast for the coordinate." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Open-Meteo Forecast", "tags": [ "openmeteo" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/openmeteo/forecast?latitude=52.52&longitude=13.41' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "100", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0001" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/supported-assets": { "get": { "description": "Get supported assets for deposits and withdrawals on the bridge.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_bridge_a35a1b89cda7__any_polymarket_bridge_apis_v1_polymarket_supporte_abc2f1", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_bridge_a35a1b89cda7__Response7A88Af0Ff8Eb_SupportedAssetsResponse" } } }, "description": "Successfully retrieved supported assets" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get supported assets", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/batch-prices-history": { "post": { "description": "Retrieve historical price data for multiple markets in a single request.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_90dffcdc0caf__any_polymarket_clob_apis_v1_polymarket_batch_pric_649cc3", "requestBody": { "content": { "application/json": { "schema": { "properties": { "end_ts": { "description": "Filter by items before this unix timestamp (seconds).", "format": "double", "type": "number" }, "fidelity": { "description": "Accuracy of the data expressed in minutes. Default is 1 minute.", "type": "integer" }, "interval": { "description": "Time interval for data aggregation.", "enum": [ "max", "all", "1m", "1w", "1d", "6h", "1h" ], "type": "string" }, "markets": { "description": "List of market asset ids to query. Maximum 20.", "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "start_ts": { "description": "Filter by items after this unix timestamp (seconds).", "format": "double", "type": "number" } }, "required": [ "markets" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_90dffcdc0caf__Response68C5148660B1_BatchPricesHistoryResponse" } } }, "description": "Successful response with price history for each market" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get batch prices history", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/book": { "get": { "description": "Retrieves the order book summary for a specific token ID. Includes bids, asks, market details, and last trade price.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_ab921bc8afec__any_polymarket_clob_apis_v1_polymarket_book", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "asks": [ { "price": "0.46", "size": "150" }, { "price": "0.47", "size": "250" } ], "asset_id": "0xabc123def456...", "bids": [ { "price": "0.45", "size": "100" }, { "price": "0.44", "size": "200" } ], "hash": "a1b2c3d4e5f6...", "last_trade_price": "0.45", "market": "0x1234567890123456789012345678901234567890", "min_order_size": "1", "neg_risk": false, "tick_size": "0.01", "timestamp": "1234567890" }, "schema": { "$ref": "#/components/schemas/polymarket_clob_ab921bc8afec__Response68C5148660B1_OrderBookSummary" } } }, "description": "Successfully retrieved order book" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get order book", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/book?token_id=0xabc123def456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/books": { "get": { "description": "Retrieves order book summaries for multiple token IDs using a request body.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_9de1af811d71__get_any_polymarket_clob_apis_v1_polymarket_books", "parameters": [ { "description": "Comma-separated list of token IDs", "example": "0xabc123...,0xdef456...", "in": "query", "name": "token_ids", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "asks": [ { "price": "0.46", "size": "150" } ], "asset_id": "0xabc123def456...", "bids": [ { "price": "0.45", "size": "100" } ], "hash": "a1b2c3d4e5f6...", "last_trade_price": "0.45", "market": "0x1234567890123456789012345678901234567890", "min_order_size": "1", "neg_risk": false, "tick_size": "0.01", "timestamp": "1234567890" } ], "schema": { "items": { "$ref": "#/components/schemas/polymarket_clob_9de1af811d71__Response68C5148660B1_OrderBookSummary" }, "type": "array" } } }, "description": "Successfully retrieved order books" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get order books (request body)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/books?token_ids=0xabc123...%2C0xdef456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "Retrieves order book summaries for multiple token IDs using a request body.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_21cb3ed36778__post_any_polymarket_clob_apis_v1_polymarket_books", "requestBody": { "content": { "application/json": { "example": [ { "token_id": "0xabc123def456..." }, { "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "side": { "description": "Order side (optional, not used for midpoint calculation)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id" ], "type": "object" }, "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "asks": [ { "price": "0.46", "size": "150" } ], "asset_id": "0xabc123def456...", "bids": [ { "price": "0.45", "size": "100" } ], "hash": "a1b2c3d4e5f6...", "last_trade_price": "0.45", "market": "0x1234567890123456789012345678901234567890", "min_order_size": "1", "neg_risk": false, "tick_size": "0.01", "timestamp": "1234567890" } ], "schema": { "items": { "$ref": "#/components/schemas/polymarket_clob_21cb3ed36778__Response68C5148660B1_OrderBookSummary" }, "type": "array" } } }, "description": "Successfully retrieved order books" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get order books (request body)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/polymarket/books \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '[\n {\n \"token_id\": \"0xabc123def456...\"\n },\n {\n \"token_id\": \"0xdef456abc123...\"\n }\n]'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/clob-markets/{condition_id}": { "get": { "description": "Returns all CLOB-level parameters for a market in a single call \u2014 tokens, tick size, base fees, rewards, RFQ status, and fee details.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_38987ccbbf6d__any_polymarket_clob_apis_v1_polymarket_clob_marke_bb5be4", "parameters": [ { "description": "The condition ID of the market", "example": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", "in": "path", "name": "condition_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_38987ccbbf6d__Response68C5148660B1_ClobMarketDetails" } } }, "description": "Successfully retrieved CLOB market info" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get CLOB market info", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/polymarket/clob-markets/0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/fee-rate": { "get": { "description": "Retrieves the base fee rate for a specific token ID. The fee rate can be provided either as a query parameter or as a path parameter.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_c6e5254fb848__any_polymarket_clob_apis_v1_polymarket_fee_rate", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "base_fee": 30 }, "schema": { "$ref": "#/components/schemas/polymarket_clob_c6e5254fb848__Response68C5148660B1_FeeRate" } } }, "description": "Successfully retrieved fee rate" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get fee rate", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/fee-rate/{token_id}": { "get": { "description": "Retrieves the base fee rate for a specific token ID using the token ID as a path parameter.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_08b984230237__any_polymarket_clob_apis_v1_polymarket_fee_rate_token_id", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "path", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "base_fee": 30 }, "schema": { "$ref": "#/components/schemas/polymarket_clob_08b984230237__Response68C5148660B1_FeeRate" } } }, "description": "Successfully retrieved fee rate" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get fee rate by path parameter", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/polymarket/fee-rate/0xabc123def456... \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/last-trade-price": { "get": { "description": "Retrieves the last trade price and side for a specific token ID. Returns default values of 0.5 for price and empty string for side if no trades found.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_1603c41c8e0c__any_polymarket_clob_apis_v1_polymarket_last_trade_price", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "price": { "description": "Last trade price", "example": "0.45", "type": "string" }, "side": { "description": "Last trade side (BUY or SELL)", "enum": [ "BUY", "SELL", "" ], "example": "BUY", "type": "string" } }, "required": [ "price", "side" ], "type": "object" } } }, "description": "Successfully retrieved last trade price" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get last trade price", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/last-trade-price?token_id=0xabc123def456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/last-trades-prices": { "get": { "description": "Retrieves last trade prices for multiple token IDs using query parameters. Maximum 500 token IDs can be requested per call.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_b1248a77a764__get_any_polymarket_clob_apis_v1_polymarket_last_t_e0a230", "parameters": [ { "description": "Comma-separated list of token IDs (max 500)", "example": "0xabc123...,0xdef456...", "in": "query", "name": "token_ids", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "price": "0.45", "side": "BUY", "token_id": "0xabc123def456..." }, { "price": "0.52", "side": "SELL", "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "price": { "description": "Last trade price", "example": "0.45", "type": "string" }, "side": { "description": "Last trade side (BUY or SELL)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id", "price", "side" ], "type": "object" }, "type": "array" } } }, "description": "Successfully retrieved last trade prices" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get last trade prices (query parameters)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/last-trades-prices?token_ids=0xabc123...%2C0xdef456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "Retrieves last trade prices for multiple token IDs using query parameters. Maximum 500 token IDs can be requested per call.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_04a27b3e22b9__post_any_polymarket_clob_apis_v1_polymarket_last__b38f3e", "requestBody": { "content": { "application/json": { "example": [ { "token_id": "0xabc123def456..." }, { "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "side": { "description": "Order side (optional, not used for midpoint calculation)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id" ], "type": "object" }, "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "price": "0.45", "side": "BUY", "token_id": "0xabc123def456..." }, { "price": "0.52", "side": "SELL", "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "price": { "description": "Last trade price", "example": "0.45", "type": "string" }, "side": { "description": "Last trade side (BUY or SELL)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id", "price", "side" ], "type": "object" }, "type": "array" } } }, "description": "Successfully retrieved last trade prices" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get last trade prices (query parameters)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/polymarket/last-trades-prices \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '[\n {\n \"token_id\": \"0xabc123def456...\"\n },\n {\n \"token_id\": \"0xdef456abc123...\"\n }\n]'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/markets-by-token/{token_id}": { "get": { "description": "Return the parent market for a given token id.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_6c721edd88f6__any_polymarket_clob_apis_v1_polymarket_markets_by_bc50a0", "parameters": [ { "description": "The token ID to look up the parent market for", "in": "path", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_6c721edd88f6__Response68C5148660B1_MarketByTokenResponse" } } }, "description": "Successfully retrieved market" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get market by token", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/midpoint": { "get": { "description": "Retrieves the midpoint price for a specific token ID. The midpoint is calculated as the average of the best bid and best ask prices.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_4873673a15a1__any_polymarket_clob_apis_v1_polymarket_midpoint", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "mid_price": { "description": "Midpoint price as a string", "example": "0.45", "type": "string" } }, "required": [ "mid_price" ], "type": "object" } } }, "description": "Successfully retrieved midpoint price" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get midpoint price", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/midpoint?token_id=0xabc123def456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/midpoints": { "get": { "description": "Retrieves midpoint prices for multiple token IDs using query parameters. The midpoint is calculated as the average of the best bid and best ask prices.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_98853e946742__get_any_polymarket_clob_apis_v1_polymarket_midpoints", "parameters": [ { "description": "Comma-separated list of token IDs", "example": "0xabc123...,0xdef456...", "in": "query", "name": "token_ids", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "0xabc123def456...": "0.45", "0xdef456abc123...": "0.52" }, "schema": { "additionalProperties": { "type": "string" }, "description": "Map of token ID to midpoint price", "type": "object" } } }, "description": "Successfully retrieved midpoint prices" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get midpoint prices (query parameters)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/midpoints?token_ids=0xabc123...%2C0xdef456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "Retrieves midpoint prices for multiple token IDs using query parameters. The midpoint is calculated as the average of the best bid and best ask prices.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_7255644e4474__post_any_polymarket_clob_apis_v1_polymarket_midpoints", "requestBody": { "content": { "application/json": { "example": [ { "token_id": "0xabc123def456..." }, { "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "side": { "description": "Order side (optional, not used for midpoint calculation)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id" ], "type": "object" }, "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "0xabc123def456...": "0.45", "0xdef456abc123...": "0.52" }, "schema": { "additionalProperties": { "type": "string" }, "description": "Map of token ID to midpoint price", "type": "object" } } }, "description": "Successfully retrieved midpoint prices" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get midpoint prices (query parameters)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/polymarket/midpoints \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '[\n {\n \"token_id\": \"0xabc123def456...\"\n },\n {\n \"token_id\": \"0xdef456abc123...\"\n }\n]'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/price": { "get": { "description": "Retrieves the best market price for a specific token ID and side (bid or ask). Returns the best bid price for BUY side or best ask price for SELL side.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_6937ed708ccf__any_polymarket_clob_apis_v1_polymarket_price", "parameters": [ { "description": "Order side", "example": "BUY", "in": "query", "name": "side", "required": true, "schema": { "enum": [ "BUY", "SELL" ], "type": "string" } }, { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "price": 0.45 }, "schema": { "properties": { "price": { "description": "Market price as a decimal number", "example": 0.45, "format": "double", "type": "number" } }, "required": [ "price" ], "type": "object" } } }, "description": "Successfully retrieved market price" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get market price", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/price?side=BUY&token_id=0xabc123def456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/prices": { "get": { "description": "Retrieves market prices for multiple token IDs and sides using query parameters.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_2974d5435bc5__get_any_polymarket_clob_apis_v1_polymarket_prices", "parameters": [ { "description": "Comma-separated list of sides (BUY or SELL) corresponding to token IDs", "example": "BUY,SELL", "in": "query", "name": "sides", "required": true, "schema": { "type": "string" } }, { "description": "Comma-separated list of token IDs", "example": "0xabc123...,0xdef456...", "in": "query", "name": "token_ids", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "0xabc123def456...": { "BUY": 0.45 }, "0xdef456abc123...": { "SELL": 0.52 } }, "schema": { "additionalProperties": { "additionalProperties": { "format": "double", "type": "number" }, "type": "object" }, "description": "Map of token ID to map of side to price", "type": "object" } } }, "description": "Successfully retrieved market prices" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get market prices (query parameters)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/prices?sides=BUY%2CSELL&token_ids=0xabc123...%2C0xdef456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } }, "post": { "description": "Retrieves market prices for multiple token IDs and sides using query parameters.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_c0e5bc22731c__post_any_polymarket_clob_apis_v1_polymarket_prices", "requestBody": { "content": { "application/json": { "example": [ { "side": "BUY", "token_id": "0xabc123def456..." }, { "side": "SELL", "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "side": { "description": "Order side (optional, not used for midpoint calculation)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id" ], "type": "object" }, "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "0xabc123def456...": { "BUY": 0.45 }, "0xdef456abc123...": { "SELL": 0.52 } }, "schema": { "additionalProperties": { "additionalProperties": { "format": "double", "type": "number" }, "type": "object" }, "description": "Map of token ID to map of side to price", "type": "object" } } }, "description": "Successfully retrieved market prices" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get market prices (query parameters)", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/polymarket/prices \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '[\n {\n \"token_id\": \"0xabc123def456...\",\n \"side\": \"BUY\"\n },\n {\n \"token_id\": \"0xdef456abc123...\",\n \"side\": \"SELL\"\n }\n]'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/prices-history": { "get": { "description": "Retrieve historical price data for a market.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_eb5de8209843__any_polymarket_clob_apis_v1_polymarket_prices_history", "parameters": [ { "description": "Filter by items before this unix timestamp.", "in": "query", "name": "endTs", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Accuracy of the data expressed in minutes. Default is 1 minute.", "in": "query", "name": "fidelity", "required": false, "schema": { "type": "integer" } }, { "description": "Time interval for data aggregation.", "in": "query", "name": "interval", "required": false, "schema": { "enum": [ "max", "all", "1m", "1w", "1d", "6h", "1h" ], "type": "string" } }, { "description": "The market (asset id) to query.", "in": "query", "name": "market", "required": true, "schema": { "type": "string" } }, { "description": "Filter by items after this unix timestamp.", "in": "query", "name": "startTs", "required": false, "schema": { "format": "double", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_eb5de8209843__Response68C5148660B1_PricesHistoryResponse" } } }, "description": "Successful response with price history" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get prices history", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/rewards/markets/current": { "get": { "description": "Returns the current active rewards configurations for markets.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_1bb98c9b6828__any_polymarket_clob_apis_v1_polymarket_rewards_ma_a68cc7", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "next_cursor", "required": false, "schema": { "type": "string" } }, { "description": "If true, returns sponsored reward configurations instead of standard ones", "in": "query", "name": "sponsored", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "count": 1, "data": [ { "condition_id": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", "native_daily_rate": 2.5, "rewards_config": [ { "asset_address": "0x9c4E1703476E875070EE25b56A58B008CFb8FA78", "end_date": "2500-12-31", "id": 0, "rate_per_day": 2, "start_date": "2024-03-01", "total_rewards": 92 }, { "asset_address": "0x69308FB512518e39F9b16112fA8d994F4e2Bf8bB", "end_date": "2500-12-31", "id": 0, "rate_per_day": 1, "start_date": "2024-03-01", "total_rewards": 46 } ], "rewards_max_spread": 99, "rewards_min_size": 10, "sponsored_daily_rate": 0.5, "sponsors_count": 2, "total_daily_rate": 3.0 } ], "limit": 500, "next_cursor": "LTE=" }, "schema": { "$ref": "#/components/schemas/polymarket_clob_1bb98c9b6828__Response68C5148660B1_PaginatedCurrentReward" } } }, "description": "Successfully retrieved current rewards configurations" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get current active rewards configurations", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/rewards/markets/multi": { "get": { "description": "Returns multiple markets with rewards and supports filtering and sorting.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_553d0e60d183__any_polymarket_clob_apis_v1_polymarket_rewards_ma_8c7184", "parameters": [ { "description": "Filter by event ID. Can be repeated for multiple events (e.g., ?event_id=100&event_id=200)", "in": "query", "name": "event_id", "required": false, "schema": { "type": "string" } }, { "description": "Search event titles using case-insensitive pattern matching", "in": "query", "name": "event_title", "required": false, "schema": { "type": "string" } }, { "description": "Maximum first token price filter", "in": "query", "name": "max_price", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Maximum spread filter", "in": "query", "name": "max_spread", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Maximum 24-hour volume filter", "in": "query", "name": "max_volume_24hr", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Minimum first token price filter", "in": "query", "name": "min_price", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Minimum spread filter", "in": "query", "name": "min_spread", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Minimum 24-hour volume filter", "in": "query", "name": "min_volume_24hr", "required": false, "schema": { "format": "double", "type": "number" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "next_cursor", "required": false, "schema": { "type": "string" } }, { "description": "Field to sort results by", "in": "query", "name": "order_by", "required": false, "schema": { "enum": [ "market_id", "created_at", "volume_24hr", "spread", "competitiveness", "max_spread", "min_size", "question", "one_day_price_change", "rate_per_day", "price", "end_date", "start_date", "reward_end_date" ], "type": "string" } }, { "description": "Number of items per page (max 500, values above are capped)", "in": "query", "name": "page_size", "required": false, "schema": { "default": 100, "maximum": 500, "type": "integer" } }, { "description": "Sort direction", "in": "query", "name": "position", "required": false, "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "Text search on market question/description", "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "description": "Filter by tag slug. Can be repeated for OR logic (e.g., ?tag_slug=sports&tag_slug=politics)", "in": "query", "name": "tag_slug", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "count": 1, "data": [ { "condition_id": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", "created_at": "2024-05-01T12:00:00Z", "end_date": "2024-08-10 00:00:00", "event_id": "12345", "event_slug": "2024-us-election", "group_item_title": "", "image": "https://example.com/image.png", "market_competitiveness": 0.42, "market_id": "248849", "market_slug": "will-trump-win-the-2024-iowa-caucus", "one_day_price_change": 0.03, "question": "Will Trump win the 2024 Iowa Caucus?", "rewards_config": [ { "asset_address": "0x9c4E1703476E875070EE25b56A58B008CFb8FA78", "end_date": "2500-12-31", "id": 7, "rate_per_day": 2, "start_date": "2024-03-01", "total_rewards": 92 } ], "rewards_max_spread": 99, "rewards_min_size": 10, "spread": 0.12, "tokens": [ { "outcome": "YES", "price": 0.8, "token_id": "1343197538147866997676250008839231694243646439454152539053893078719042421992" }, { "outcome": "NO", "price": 0.2, "token_id": "16678291189211314787145083999015737376658799626183230671758641503291735614088" } ], "volume_24hr": 12345.67 } ], "limit": 50, "next_cursor": "NQ==" }, "schema": { "$ref": "#/components/schemas/polymarket_clob_553d0e60d183__Response68C5148660B1_PaginatedMultiMarketInfo" } } }, "description": "Successfully retrieved markets with rewards" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get multiple markets with rewards", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/rewards/markets/{condition_id}": { "get": { "description": "Returns raw rewards configuration for a specific market.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_4599a92b1e7b__any_polymarket_clob_apis_v1_polymarket_rewards_ma_06def4", "parameters": [ { "description": "The condition ID of the market", "example": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", "in": "path", "name": "condition_id", "required": true, "schema": { "type": "string" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "next_cursor", "required": false, "schema": { "type": "string" } }, { "description": "If true, folds sponsored daily rates into each config's rate_per_day", "in": "query", "name": "sponsored", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "count": 1, "data": [ { "condition_id": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", "event_slug": "will-trump-win-the-2024-iowa-caucus", "image": "https://polymarket-upload.s3.us-east-2.amazonaws.com/trump1+copy.png", "market_competitiveness": 0.42, "market_slug": "will-trump-win-the-2024-iowa-caucus", "question": "Will Trump win the 2024 Iowa Caucus?", "rewards_config": [ { "asset_address": "0x9c4E1703476E875070EE25b56A58B008CFb8FA78", "end_date": "2500-12-31", "id": 1, "rate_per_day": 0.25, "start_date": "2024-03-01", "total_days": 174161, "total_rewards": 0 }, { "asset_address": "0x9c4E1703476E875070EE25b56A58B008CFb8FA78", "end_date": "2024-05-31", "id": 2, "rate_per_day": 1, "start_date": "2024-03-01", "total_days": 92, "total_rewards": 92 } ], "rewards_max_spread": 99, "rewards_min_size": 10, "tokens": [ { "outcome": "YES", "price": 0.8, "token_id": "1343197538147866997676250008839231694243646439454152539053893078719042421992" }, { "outcome": "NO", "price": 0.2, "token_id": "16678291189211314787145083999015737376658799626183230671758641503291735614088" } ] } ], "limit": 100, "next_cursor": "LTE=" }, "schema": { "$ref": "#/components/schemas/polymarket_clob_4599a92b1e7b__Response68C5148660B1_PaginatedMarketReward" } } }, "description": "Successfully retrieved rewards for market" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get raw rewards for a specific market", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/polymarket/rewards/markets/0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/sampling-markets": { "get": { "description": "Returns sampling markets with richer descriptive metadata, token summaries, and tags.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_cee92151ea24__any_polymarket_clob_apis_v1_polymarket_sampling_markets", "parameters": [ { "in": "query", "name": "next_cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_cee92151ea24__Response68C5148660B1_PaginatedMarkets" } } }, "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get sampling markets", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/sampling-simplified-markets": { "get": { "description": "Returns sampling simplified markets with reward and token summaries.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_84e3aef08472__any_polymarket_clob_apis_v1_polymarket_sampling_s_cd1ebe", "parameters": [ { "in": "query", "name": "next_cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_84e3aef08472__Response68C5148660B1_PaginatedSimplifiedMarkets" } } }, "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get sampling simplified markets", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/simplified-markets": { "get": { "description": "Returns simplified CLOB markets with token and reward summaries.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_ab9f10d53db3__any_polymarket_clob_apis_v1_polymarket_simplified_cec760", "parameters": [ { "in": "query", "name": "next_cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_clob_ab9f10d53db3__Response68C5148660B1_PaginatedSimplifiedMarkets" } } }, "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get simplified markets", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/spread": { "get": { "description": "Retrieves the spread for a specific token ID. The spread is the difference between the best ask and best bid prices.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_3e695ce2c557__any_polymarket_clob_apis_v1_polymarket_spread", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "spread": { "description": "Spread as a string", "example": "0.02", "type": "string" } }, "required": [ "spread" ], "type": "object" } } }, "description": "Successfully retrieved spread" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get spread", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/spread?token_id=0xabc123def456...' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/spreads": { "post": { "description": "Retrieves spreads for multiple token IDs. The spread is the difference between the best ask and best bid prices.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_0f05d98bad43__any_polymarket_clob_apis_v1_polymarket_spreads", "requestBody": { "content": { "application/json": { "example": [ { "token_id": "0xabc123def456..." }, { "token_id": "0xdef456abc123..." } ], "schema": { "items": { "properties": { "side": { "description": "Order side (optional, not used for midpoint calculation)", "enum": [ "BUY", "SELL" ], "example": "BUY", "type": "string" }, "token_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" } }, "required": [ "token_id" ], "type": "object" }, "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "0xabc123def456...": "0.02", "0xdef456abc123...": "0.015" }, "schema": { "additionalProperties": { "type": "string" }, "description": "Map of token ID to spread", "type": "object" } } }, "description": "Successfully retrieved spreads" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get spreads", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request POST \\\n --url https://api.aisa.one/apis/v1/polymarket/spreads \\\n --header 'Authorization: Bearer ' \\\n --header 'Content-Type: application/json' \\\n --data '[\n {\n \"token_id\": \"0xabc123def456...\"\n },\n {\n \"token_id\": \"0xdef456abc123...\"\n }\n]'" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tick-size": { "get": { "description": "Retrieves the minimum tick size (price increment) for a specific token ID. The tick size can be provided either as a query parameter or as a path parameter.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_6ad1f9f9b2f3__any_polymarket_clob_apis_v1_polymarket_tick_size", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "query", "name": "token_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "minimum_tick_size": 0.01 }, "schema": { "$ref": "#/components/schemas/polymarket_clob_6ad1f9f9b2f3__Response68C5148660B1_TickSize" } } }, "description": "Successfully retrieved tick size" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get tick size", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tick-size/{token_id}": { "get": { "description": "Retrieves the minimum tick size (price increment) for a specific token ID using the token ID as a path parameter.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_8305185169e4__any_polymarket_clob_apis_v1_polymarket_tick_size__0863ab", "parameters": [ { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "in": "path", "name": "token_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "minimum_tick_size": 0.01 }, "schema": { "$ref": "#/components/schemas/polymarket_clob_8305185169e4__Response68C5148660B1_TickSize" } } }, "description": "Successfully retrieved tick size" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get tick size by path parameter", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url https://api.aisa.one/apis/v1/polymarket/tick-size/0xabc123def456... \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/time": { "get": { "description": "Returns the current Unix timestamp of the server. This can be used to synchronize client time with server time.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_clob_5dc8e617a60b__any_polymarket_clob_apis_v1_polymarket_time", "responses": { "200": { "content": { "application/json": { "example": 1234567890, "schema": { "description": "Unix timestamp (seconds since epoch)", "format": "int64", "type": "integer" } } }, "description": "Successfully retrieved server time" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get server time", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/activity": { "get": { "description": "Returns user activity with pagination and filtering.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_b80dbc0fafd4__get_polymarket_activity", "parameters": [ { "description": "Upper-bound timestamp (epoch seconds) for the activity window. Omit for the default (current time); rows newer than `end` are excluded.", "in": "query", "name": "end", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of event IDs. Mutually exclusive with market.", "explode": false, "in": "query", "name": "eventId", "schema": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Excludes deposit and withdrawal records. The default `true` applies even when `type` requests those records, so to get deposits and withdrawals you must pass `false`.", "in": "query", "name": "excludeDepositsWithdrawals", "schema": { "default": true, "type": "boolean" } }, { "description": "Page size. Values above the maximum are clamped to 500.", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 500, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of condition IDs. Mutually exclusive with eventId.", "explode": false, "in": "query", "name": "market", "schema": { "items": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Starting index for pagination. Requests past the cap are rejected with a 400 (never silently clamped). To read history deeper than offset 5000, page inside `start`/`end` windows \u2014 each window has its own offset budget.", "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 5000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "side", "schema": { "enum": [ "BUY", "SELL" ], "type": "string" } }, { "in": "query", "name": "sortBy", "schema": { "default": "TIMESTAMP", "enum": [ "TIMESTAMP", "TOKENS", "CASH" ], "type": "string" } }, { "description": "`DESC` (default) returns the newest rows first; `ASC` the oldest first. Both orders are stable \u2014 the same query returns the same rows at any `limit`/`offset`, so pages compose without gaps or repeats.", "in": "query", "name": "sortDirection", "schema": { "default": "DESC", "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "Lower-bound timestamp (epoch seconds) for the activity window. Omit or pass `0` for the default window (most recent ~3 years); pass a positive epoch (e.g. `1`) to retrieve full history. With `sortDirection=ASC`, omitting `start` already reads from the beginning of the account's history (no default window).", "in": "query", "name": "start", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of activity types to include. DEPOSIT and WITHDRAWAL records also require `excludeDepositsWithdrawals=false`.", "explode": false, "in": "query", "name": "type", "schema": { "items": { "enum": [ "TRADE", "SPLIT", "MERGE", "REDEEM", "REWARD", "CONVERSION", "DEPOSIT", "WITHDRAWAL", "YIELD", "MAKER_REBATE", "TAKER_REBATE", "REFERRAL_REWARD" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "user", "required": true, "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_b80dbc0fafd4__Response65D835437A58_Activity" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get user activity", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/activity?user=0x56687bf447db6ffa42ffe2204a05edaa20f55839' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/closed-positions": { "get": { "description": "Returns closed positions for a user.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_f293eb424810__any_polymarket_data_apis_v1_polymarket_closed_positions", "parameters": [ { "description": "The event id of the event in question. Supports multiple csv separated values. Returns positions for all markets for those event ids. Cannot be used with the market param.", "explode": false, "in": "query", "name": "eventId", "schema": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "The max number of positions to return", "in": "query", "name": "limit", "schema": { "default": 10, "maximum": 50, "minimum": 0, "type": "integer" } }, { "description": "The conditionId of the market in question. Supports multiple csv separated values. Cannot be used with the eventId param.", "explode": false, "in": "query", "name": "market", "schema": { "items": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The starting index for pagination", "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 100000, "minimum": 0, "type": "integer" } }, { "description": "The sort criteria", "in": "query", "name": "sortBy", "schema": { "default": "REALIZEDPNL", "enum": [ "REALIZEDPNL", "TITLE", "PRICE", "AVGPRICE", "TIMESTAMP" ], "type": "string" } }, { "description": "The sort direction", "in": "query", "name": "sortDirection", "schema": { "default": "DESC", "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "Filter by market title", "in": "query", "name": "title", "schema": { "maxLength": 100, "type": "string" } }, { "description": "The address of the user in question", "in": "query", "name": "user", "required": true, "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_f293eb424810__Response65D835437A58_ClosedPosition" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get closed positions for a user", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/closed-positions?user=0x56687bf447db6ffa42ffe2204a05edaa20f55839' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/holders": { "get": { "description": "Get top holders for one or more markets.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_31311d8c5221__any_polymarket_data_apis_v1_polymarket_holders", "parameters": [ { "description": "Maximum number of holders to return per token. Capped at 20.", "in": "query", "name": "limit", "schema": { "default": 20, "maximum": 20, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of condition IDs.", "explode": false, "in": "query", "name": "market", "required": true, "schema": { "items": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "minBalance", "schema": { "default": 1, "maximum": 999999, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_31311d8c5221__Response65D835437A58_MetaHolder" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get top holders for markets", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/live-volume": { "get": { "description": "Get live volume for an event.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_02738f46225f__any_polymarket_data_apis_v1_polymarket_live_volume", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_02738f46225f__Response65D835437A58_LiveVolume" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get live volume for an event", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/oi": { "get": { "description": "Get open interest for one or more markets.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_4872c30d3c60__any_polymarket_data_apis_v1_polymarket_oi", "parameters": [ { "explode": false, "in": "query", "name": "market", "schema": { "items": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_4872c30d3c60__Response65D835437A58_OpenInterest" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get open interest", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/positions": { "get": { "description": "Returns current positions for a user.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_22184f5f2aab__any_polymarket_data_apis_v1_polymarket_positions", "parameters": [ { "description": "Comma-separated list of event IDs. Mutually exclusive with market.", "explode": false, "in": "query", "name": "eventId", "schema": { "items": { "minimum": 1, "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Include positions in archived markets that are still active. Archived positions are excluded by default.", "in": "query", "name": "includeArchived", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 500, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of condition IDs. Mutually exclusive with eventId.", "explode": false, "in": "query", "name": "market", "schema": { "items": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "mergeable", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 10000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "redeemable", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "sizeThreshold", "schema": { "default": 1.0, "minimum": 0, "type": "number" } }, { "in": "query", "name": "sortBy", "schema": { "default": "TOKENS", "enum": [ "CURRENT", "INITIAL", "TOKENS", "CASHPNL", "PERCENTPNL", "TITLE", "RESOLVING", "PRICE", "AVGPRICE" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "schema": { "default": "DESC", "enum": [ "ASC", "DESC" ], "type": "string" } }, { "in": "query", "name": "title", "schema": { "maxLength": 100, "type": "string" } }, { "description": "User address (required)", "in": "query", "name": "user", "required": true, "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_22184f5f2aab__Response65D835437A58_Position" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get current positions for a user", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/positions?user=0x56687bf447db6ffa42ffe2204a05edaa20f55839' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/traded": { "get": { "description": "Returns the total number of markets a user has traded.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_98db2fb30124__any_polymarket_data_apis_v1_polymarket_traded", "parameters": [ { "in": "query", "name": "user", "required": true, "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_data_98db2fb30124__Response65D835437A58_Traded" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get total markets a user has traded", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/traded?user=0x56687bf447db6ffa42ffe2204a05edaa20f55839' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/v1/builders/leaderboard": { "get": { "description": "Returns aggregated builder leaderboard rankings.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_351a5fa3e498__any_polymarket_data_apis_v1_polymarket_v1_builder_e3d670", "parameters": [ { "description": "Maximum number of builders to return", "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 50, "minimum": 0, "type": "integer" } }, { "description": "Starting index for pagination", "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The time period to aggregate results over.\n", "in": "query", "name": "timePeriod", "schema": { "default": "DAY", "enum": [ "DAY", "WEEK", "MONTH", "ALL" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_351a5fa3e498__Response65D835437A58_LeaderboardEntry" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get aggregated builder leaderboard", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/v1/builders/volume": { "get": { "description": "Returns daily builder volume time-series data.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_341c90dce1ab__any_polymarket_data_apis_v1_polymarket_v1_builder_c3f154", "parameters": [ { "description": "The time period to fetch daily records for.\n", "in": "query", "name": "timePeriod", "schema": { "default": "DAY", "enum": [ "DAY", "WEEK", "MONTH", "ALL" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_341c90dce1ab__Response65D835437A58_BuilderVolumeEntry" }, "type": "array" } } }, "description": "Success - Returns array of daily volume records" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get daily builder volume time-series", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/v1/leaderboard": { "get": { "description": "Returns trader leaderboard rankings for a selected category and time period.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_ad51d09635a6__any_polymarket_data_apis_v1_polymarket_v1_leaderboard", "parameters": [ { "description": "Market category for the leaderboard", "in": "query", "name": "category", "schema": { "default": "OVERALL", "enum": [ "OVERALL", "POLITICS", "SPORTS", "ESPORTS", "CRYPTO", "CULTURE", "MENTIONS", "WEATHER", "ECONOMICS", "TECH", "FINANCE" ], "type": "string" } }, { "description": "Max number of leaderboard traders to return", "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 50, "minimum": 1, "type": "integer" } }, { "description": "Starting index for pagination", "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "Leaderboard ordering criteria", "in": "query", "name": "orderBy", "schema": { "default": "PNL", "enum": [ "PNL", "VOL" ], "type": "string" } }, { "description": "Time period for leaderboard results", "in": "query", "name": "timePeriod", "schema": { "default": "DAY", "enum": [ "DAY", "WEEK", "MONTH", "ALL" ], "type": "string" } }, { "description": "Limit leaderboard to a single user by address", "in": "query", "name": "user", "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } }, { "description": "Limit leaderboard to a single username", "in": "query", "name": "userName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_ad51d09635a6__Response65D835437A58_TraderLeaderboardEntry" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get trader leaderboard rankings", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/v1/market-positions": { "get": { "description": "Returns positions for a market, optionally filtered to a single user.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_45a4e04908fc__any_polymarket_data_apis_v1_polymarket_v1_market__d8f158", "parameters": [ { "description": "Max number of positions to return per outcome token", "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 500, "minimum": 0, "type": "integer" } }, { "description": "The condition ID of the market to query positions for", "in": "query", "name": "market", "required": true, "schema": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" } }, { "description": "Pagination offset per outcome token", "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 10000, "minimum": 0, "type": "integer" } }, { "description": "Sort positions by:\n- `TOKENS` \u2014 Position size (number of tokens)\n- `CASH_PNL` \u2014 Unrealized cash PnL\n- `REALIZED_PNL` \u2014 Realized PnL\n- `TOTAL_PNL` \u2014 Total PnL (cash_pnl + realized_pnl)\n", "in": "query", "name": "sortBy", "schema": { "default": "TOTAL_PNL", "enum": [ "TOKENS", "CASH_PNL", "REALIZED_PNL", "TOTAL_PNL" ], "type": "string" } }, { "in": "query", "name": "sortDirection", "schema": { "default": "DESC", "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "Filter positions by status.\n- `OPEN` \u2014 Only positions with size > 0.01\n- `CLOSED` \u2014 Only positions with size <= 0.01\n- `ALL` \u2014 All positions regardless of size\n", "in": "query", "name": "status", "schema": { "default": "ALL", "enum": [ "OPEN", "CLOSED", "ALL" ], "type": "string" } }, { "description": "Filter to a single user by proxy wallet address", "in": "query", "name": "user", "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_45a4e04908fc__Response65D835437A58_MetaMarketPositionV1" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get positions for a market", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/v1/market-positions?market=0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/value": { "get": { "description": "Returns the total value of a user's positions.\n\n\nPublished reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_data_6c308ca67cf6__any_polymarket_data_apis_v1_polymarket_value", "parameters": [ { "explode": false, "in": "query", "name": "market", "schema": { "items": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "user", "required": true, "schema": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_data_6c308ca67cf6__Response65D835437A58_Value" }, "type": "array" } } }, "description": "Success" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get total value of a user's positions", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/value?user=0x56687bf447db6ffa42ffe2204a05edaa20f55839' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "12000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.012" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/comments": { "get": { "description": "List comments.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_83be8d2e6735__any_polymarket_gamma_apis_v1_polymarket_comments", "parameters": [ { "in": "query", "name": "ascending", "schema": { "type": "boolean" } }, { "in": "query", "name": "get_positions", "schema": { "type": "boolean" } }, { "in": "query", "name": "holders_only", "schema": { "type": "boolean" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of fields to order by", "in": "query", "name": "order", "schema": { "type": "string" } }, { "in": "query", "name": "parent_entity_id", "schema": { "type": "integer" } }, { "in": "query", "name": "parent_entity_type", "schema": { "enum": [ "Event", "Series", "market" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_83be8d2e6735__Response8689C55A3B97_Comment" }, "type": "array" } } }, "description": "List of comments" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "List comments", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/comments/user_address/{user_address}": { "get": { "description": "Get comments by user address.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_3abab4d1129f__any_polymarket_gamma_apis_v1_polymarket_comments__8b6eef", "parameters": [ { "in": "path", "name": "user_address", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "ascending", "schema": { "type": "boolean" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of fields to order by", "in": "query", "name": "order", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_3abab4d1129f__Response8689C55A3B97_Comment" }, "type": "array" } } }, "description": "Comments" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get comments by user address", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/comments/{id}": { "get": { "description": "Get comments by comment id.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_afcea9ec2990__any_polymarket_gamma_apis_v1_polymarket_comments_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "get_positions", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_afcea9ec2990__Response8689C55A3B97_Comment" }, "type": "array" } } }, "description": "Comments" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get comments by comment id", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/events/{id}/tags": { "get": { "description": "Get tags attached to an event.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_90f1b7f81e46__any_polymarket_gamma_apis_v1_polymarket_events_id_tags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_90f1b7f81e46__Response8689C55A3B97_Tag" }, "type": "array" } } }, "description": "Tags attached to the event" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get event tags", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/markets/{id}/tags": { "get": { "description": "Get tags attached to a market.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_785977d6068a__any_polymarket_gamma_apis_v1_polymarket_markets_id_tags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_785977d6068a__Response8689C55A3B97_Tag" }, "type": "array" } } }, "description": "Tags attached to the market" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get market tags by id", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/public-profile": { "get": { "description": "Returns the public profile for a wallet address.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_91347b3da84c__any_polymarket_gamma_apis_v1_polymarket_public_profile", "parameters": [ { "description": "The wallet address (proxy wallet or user address)", "example": "0x7c3db723f1d4d8cb9c550095203b686cb11e5c6b", "in": "query", "name": "address", "required": true, "schema": { "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_gamma_91347b3da84c__Response8689C55A3B97_PublicProfileResponse" } } }, "description": "Public profile information" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get public profile by wallet address", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/polymarket/public-profile?address=0x7c3db723f1d4d8cb9c550095203b686cb11e5c6b' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/sports": { "get": { "description": "Get sports metadata information.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_9ee1b4ac4904__any_polymarket_gamma_apis_v1_polymarket_sports", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_9ee1b4ac4904__Response8689C55A3B97_SportsMetadata" }, "type": "array" } } }, "description": "List of sports metadata objects containing sport configuration details, visual assets, and related identifiers" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get sports metadata information", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/sports/market-types": { "get": { "description": "Get valid sports market types.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_61af7877d745__any_polymarket_gamma_apis_v1_polymarket_sports_ma_6fbbf6", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_gamma_61af7877d745__Response8689C55A3B97_SportsMarketTypesResponse" } } }, "description": "List of valid sports market types" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get valid sports market types", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags": { "get": { "description": "Lists tags with optional filters.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_ab2a847f055c__any_polymarket_gamma_apis_v1_polymarket_tags", "parameters": [ { "in": "query", "name": "ascending", "schema": { "type": "boolean" } }, { "in": "query", "name": "include_template", "schema": { "type": "boolean" } }, { "in": "query", "name": "is_carousel", "schema": { "type": "boolean" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of fields to order by", "in": "query", "name": "order", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_ab2a847f055c__Response8689C55A3B97_Tag" }, "type": "array" } } }, "description": "List of tags" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "List tags", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags/slug/{slug}": { "get": { "description": "Gets a tag by slug.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_78ec97965363__any_polymarket_gamma_apis_v1_polymarket_tags_slug_slug", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "include_template", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_gamma_78ec97965363__Response8689C55A3B97_Tag" } } }, "description": "Tag" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get tag by slug", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags/slug/{slug}/related-tags": { "get": { "description": "Gets related tag relationships by tag slug.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_35fa5e300173__any_polymarket_gamma_apis_v1_polymarket_tags_slug_9b83a4", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "omit_empty", "schema": { "type": "boolean" } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "closed", "all" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_35fa5e300173__Response8689C55A3B97_RelatedTag" }, "type": "array" } } }, "description": "Related tag relationships" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get related tags (relationships) by tag slug", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags/slug/{slug}/related-tags/tags": { "get": { "description": "Gets tags related to a tag slug.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_a6e411ef833a__any_polymarket_gamma_apis_v1_polymarket_tags_slug_e8659d", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "omit_empty", "schema": { "type": "boolean" } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "closed", "all" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_a6e411ef833a__Response8689C55A3B97_Tag" }, "type": "array" } } }, "description": "Related tags" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get tags related to a tag slug", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags/{id}": { "get": { "description": "Gets a tag by numeric id.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_c4db0c4308fd__any_polymarket_gamma_apis_v1_polymarket_tags_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "include_template", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/polymarket_gamma_c4db0c4308fd__Response8689C55A3B97_Tag" } } }, "description": "Tag" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get tag by id", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags/{id}/related-tags": { "get": { "description": "Gets related tag relationships by tag id.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_1a1a0b0bbdd4__any_polymarket_gamma_apis_v1_polymarket_tags_id_r_4c9f65", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "omit_empty", "schema": { "type": "boolean" } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "closed", "all" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_1a1a0b0bbdd4__Response8689C55A3B97_RelatedTag" }, "type": "array" } } }, "description": "Related tag relationships" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get related tags (relationships) by tag id", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/tags/{id}/related-tags/tags": { "get": { "description": "Gets tags related to a tag id.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_c698b43e93ad__any_polymarket_gamma_apis_v1_polymarket_tags_id_r_0c4b20", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "omit_empty", "schema": { "type": "boolean" } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "closed", "all" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_c698b43e93ad__Response8689C55A3B97_Tag" }, "type": "array" } } }, "description": "Related tags" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Get tags related to a tag id", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/polymarket/teams": { "get": { "description": "List teams.\n\n\nPublished reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "polymarket_gamma_1153b9cce798__any_polymarket_gamma_apis_v1_polymarket_teams", "parameters": [ { "in": "query", "name": "abbreviation", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "ascending", "schema": { "type": "boolean" } }, { "in": "query", "name": "league", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "name", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of fields to order by", "in": "query", "name": "order", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/polymarket_gamma_1153b9cce798__Response8689C55A3B97_Team" }, "type": "array" } } }, "description": "List of teams" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "List teams", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "440", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.00044" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/querit/search": { "post": { "description": "Perform a search query using AI to retrieve relevant information based on the provided criteria.\n\n\nPublished reference price: $0.0048 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "querit_32030ca180f2__any_querit_apis_v1_querit_search", "requestBody": { "content": { "application/json": { "schema": { "properties": { "chunksPerDoc": { "default": 1, "description": "Summary chunks per document. Free / PAYG support up to 1; Enterprise up to 3. Deprecated \u2014 still available, but migrate to highlights", "type": "integer" }, "contentMaxChars": { "description": "Optional body-text length limit per result, from 1 to 1,000,000 Unicode code points. Used with needContent: true; omit or send null to return the full available body text without truncation. Default: Full available body text (value unspecified).", "type": "integer" }, "count": { "description": "Maximum number of results returned. Default: server default (value unspecified).", "type": "integer" }, "filters": { "description": "Filter conditions, see below", "properties": { "geo": { "properties": { "countries": { "properties": { "include": { "description": "Only return results from these countries", "items": { "enum": [ "argentina", "australia", "brazil", "canada", "colombia", "france", "germany", "india", "indonesia", "japan", "mexico", "nigeria", "philippines", "south korea", "spain", "united kingdom", "united states" ], "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "languages": { "properties": { "include": { "description": "Only return results in these languages", "items": { "enum": [ "english", "japanese", "korean", "german", "french", "spanish", "portuguese", "russian" ], "type": "string" }, "type": "array" } }, "type": "object" }, "sites": { "properties": { "exclude": { "description": "Exclude these sites", "items": { "type": "string" }, "type": "array" }, "include": { "description": "Only pull results from these sites; an empty array means no restriction", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "timeRange": { "properties": { "date": { "description": "Time range, syntax below", "type": "string" } }, "type": "object" }, "vertical": { "description": "Vertical search. Supported values: \"code\", \"finance\"; omit for universal search", "enum": [ "code", "finance" ], "type": "string" } }, "type": "object" }, "highlights": { "anyOf": [ { "type": "boolean" }, { "properties": { "maxCharacters": { "description": "Length of each extracted fragment, in characters, between 100 and 8000; the model picks the most suitable length when omitted", "maximum": 8000, "minimum": 100, "type": "integer" }, "query": { "description": "Keyword that guides the extraction; falls back to the top-level query when omitted", "type": "string" } }, "type": "object" } ], "description": "Request relevant fragments from the body text. true extracts against the original query at the length the model judges best; the object form takes query and maxCharacters, see below" }, "needContent": { "default": false, "description": "Whether to return body text. When true, body text lands in each result's sentence field (sentence array)", "type": "boolean" }, "query": { "description": "Search term. Supports long natural-language descriptions", "type": "string" } }, "required": [ "query" ], "type": "object" } } }, "description": "Top-level parameters:\nhighlights object form:\ncontentMaxChars body-text limit:\nThis is a top-level integer, not a field inside highlights. Only send it when you need to limit returned body text. With needContent: true and body-content access enabled, it limits the total characters across all strings in each result's sentence array, independently per result. Omit it or send null for the full available body text.\nThe limit counts Unicode code points in UTF-8 body text, preserves sentence order, and may cut the last retained sentence short. It does not include JSON formatting or separators added by your application. It does not limit snippet or highlights, and it does not change page-based billing. Use highlights.maxCharacters (100\u20138000) to control query-focused fragments separately.\nfilters sub-object:\ntimeRange.date syntax:\nd[n] / w[n] / m[n] / y[n]: last n days / weeks / months / years, e.g. d7, m3\nYYYY-MM-DDtoYYYY-MM-DD: a range, e.g. 2022-04-01to2022-07-30; a single day uses the same to form\ngeo.countries.include allowed values: argentina, australia, brazil, canada, colombia, france, germany, india, indonesia, japan, mexico, nigeria, philippines, south korea, spain, united kingdom, united states.\nlanguages.include allowed values: english, japanese, korean, german, french, spanish, portuguese, russian.\nvertical allowed values: code, finance. Lowercase and strictly enumerated; omit the field for universal search.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "error_code": { "description": "Error code, consistent with the HTTP status code; 200 on success", "type": "integer" }, "error_msg": { "description": "Error detail", "type": "string" }, "query_context": { "properties": { "query": { "description": "The query that was actually executed", "type": "string" } }, "type": "object" }, "results": { "properties": { "result": { "description": "Result array", "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "search_id": { "description": "Unique request identifier; give it to support when reporting an issue", "type": "integer" }, "took": { "description": "Server-side processing time", "type": "string" } }, "type": "object" } } }, "description": "Official response table. Fields on each results.result[] item: url, title, snippet, page_age (plaintext UTC+0 time), site_name, site_icon, sentence (string[], present only when needContent: true and body text is available), highlights (string[], present only when highlights is set on the request and body text is available). Every result field is optional. Some results in the same response may have no sentence or highlights. Treat a missing field as \"body text unavailable,\" not as an error." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Search AI Data", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "4800", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.0048" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/scholar/search/explain": { "post": { "description": "Explain a result set you already fetched. Unlike the three search endpoints this one takes a **JSON body**: `search_id` (required \u2014 the `id` returned by `post_scholar_search_web`, `post_scholar_search_scholar` or `post_scholar_search_mixed`), plus `detail_level` (BRIEF / MODERATE / DETAILED), `language`, and `response_mode`. \u26a0\ufe0f Use `response_mode: NON_STREAMING`. It returns `{\"message\": \"\u2026\"}` as JSON, measured at about 2 KB. The COMPLETE and INCREMENTAL modes emit server-sent events in which **each event repeats the whole answer so far** \u2014 the identical explanation measured 177 KB that way, roughly 90 times larger, and a tool call cannot consume a stream incrementally anyway. It only ever explains an existing search; it cannot run one.\n\n\nPublished reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "scholar_3b73ab6b6162__post_scholar_search_explain", "requestBody": { "content": { "application/json": { "schema": { "properties": { "detail_level": { "default": "MODERATE", "description": "Level of detail in the explanation", "enum": [ "BRIEF", "MODERATE", "DETAILED" ], "type": "string" }, "language": { "default": "en", "description": "Language code for the explanation (e.g., en, zh, ar)", "example": "ar", "type": "string" }, "response_mode": { "default": "NON_STREAMING", "description": "Format of the explanation response. COMPLETE and INCREMENTAL stream server-sent events; NON_STREAMING returns a JSON response.", "enum": [ "COMPLETE", "INCREMENTAL", "NON_STREAMING" ], "type": "string" }, "search_id": { "description": "ID of the search to explain", "type": "string" } }, "required": [ "search_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scholar_3b73ab6b6162__Response8Da310D1D213_ExplainSearchResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful explanation response. COMPLETE/INCREMENTAL stream text/event-stream; NON_STREAMING returns application/json." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Explain Search Results", "tags": [ "default" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.01" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/search/full": { "get": { "description": "Searchfor web content and retrieve full text content with advanced filtering optionsincluding freshness, market, and safety filters\n\n\nPublished reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "search_4a85bccaf5f4__any_search_apis_v1_search_full", "parameters": [ { "description": "Atwo-character country code indicating the country from which the resultoriginated.", "in": "query", "name": "cc", "required": false, "schema": { "maxLength": 2, "type": "string" } }, { "description": "Enumeration value that affects the format of the full text contentreturned", "in": "query", "name": "contentType", "required": false, "schema": { "enum": [ "HTML", "MARKDOWN" ], "type": "string" } }, { "description": "Number of search results included in the return results", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "Filter search results by time values: Day, Week, Month. To get articleswithin a specific time range, specify a date range in the formatYYYY-MM-DD..YYYY-MM-DD. For example, 2019-02-01..2019-05-30.", "in": "query", "name": "freshness", "required": false, "schema": { "type": "string" } }, { "description": "Themarket from which the results come. Usually, mkt is the country where the usermade the request. The market must be in the language-country format. Forexample, en-US. The string is case-insensitive.", "in": "query", "name": "mkt", "required": false, "schema": { "type": "string" } }, { "description": "Theoffset from zero, indicating the number of search results to skip beforereturning results. The default value is 0. Use this parameter with the countparameter to paginate the results.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "format": "int16", "type": "integer" } }, { "description": "Theuser's search query. This string cannot be empty. The query can containadvanced operators.", "in": "query", "name": "q", "required": true, "schema": { "type": "string" } }, { "description": "Usedto filter adult content in web pages, images, and videos.", "in": "query", "name": "safeSearch", "required": false, "schema": { "enum": [ "Off", "Moderate", "Strict" ], "type": "string" } }, { "description": "Thelanguage for User Interface strings. You can use a 2-letter or 4-letter code tospecify the language. A 4-letter code is recommended in the form language-country,where language is an ISO 639-1 language code and country is an ISO 3166country/region code. For example, use en-US for US English.", "in": "query", "name": "setLang", "required": false, "schema": { "type": "string" } }, { "description": "Aboolean value that determines whether the display string in the result shouldcontain decoration markers (such as hit highlighting characters). If true, thestring may contain markers. The default value is false.", "in": "query", "name": "textDecorations", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "queryContext": { "properties": { "originalQuery": { "description": "The query string specified in therequest", "type": "string" } }, "type": "object" }, "webPages": { "properties": { "value": { "items": { "properties": { "content": { "description": "Full text content of the web page.", "type": "string" }, "datePublished": { "description": "The time when the web page waspublished.", "format": "date-time", "type": "string" }, "displayUrl": { "description": "The display URL of the web page.", "type": "string" }, "logo": { "description": "The URL of the site's logo orfavicon.", "type": "string" }, "name": { "description": "The name of the web page. Use this nameand the URL to create a hyperlink that users can click to go to the webpage.", "type": "string" }, "siteName": { "description": "Thesource of the web page", "type": "string" }, "snippet": { "description": "A text snippet that describes the contentof a web page.", "type": "string" }, "url": { "description": "The URL of the web page. Use this URL andname to create a hyperlink that the user can click to go to the web page.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful full text search response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Perform Full Text Search", "tags": [ "search" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "1000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.001" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/search/smart": { "get": { "description": "\nPublished reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "search_c015d627b88c__any_search_apis_v1_search_smart", "parameters": [ { "description": "Input value: no-cache. When no-cache is provided, the response results will not be cached and each request is independent; if not provided, the response results for the same query term will be cached for 10 minutes", "in": "header", "name": "Pragma", "required": false, "schema": { "type": "string" } }, { "description": "The value must be in host address format (e.g., baijiahao.baidu.com). Excludes results from the specified site(s).", "in": "query", "name": "blockWebsites", "required": false, "schema": { "type": "string" } }, { "description": "Timeout for reading long abstracts. If reading exceeds this time, it will terminate and no long abstract will be returned for that result. Defaults to 0 (seconds), maximum 10s.", "in": "query", "name": "contentTimeout", "required": false, "schema": { "default": 0.0, "maximum": 10.0, "type": "number" } }, { "description": "The format of the long abstract (content) to return. Options:\uff1a- HTML- MARKDOWN- TEXT(default)", "in": "query", "name": "contentType", "required": false, "schema": { "default": "TEXT", "enum": [ "HTML", "MARKDOWN", "TEXT" ], "type": "string" } }, { "description": "The number of search results to return. Defaults to 10, maximum 50. Enumerated values: 10 / 20 / 30 / 40 / 50 The actual number returned may be less than requested. Use this parameter with the offset parameter for pagination.", "in": "query", "name": "count", "required": false, "schema": { "default": 10, "enum": [ 10, 20, 30, 40, 50 ], "maximum": 50, "type": "integer" } }, { "description": "ontrols whether to return long abstract content: -true: Return long abstracts -false: Do not return long abstracts Defaults to false", "in": "query", "name": "enableContent", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Filter search results by time range: - Day (past 24 hours) -Week (past 7 days) - Month (past 30 days)", "in": "query", "name": "freshness", "required": false, "schema": { "enum": [ "Day", "Week", "Month" ], "type": "string" } }, { "description": "Controls whether to return key fragments of dynamic abstracts:true\uff1a Return key fragmentsfalse\uff1aDo not return key fragmentsDefault false", "in": "query", "name": "mainText", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "The zero-based offset indicating how many results to skip before returning. Defaults to 0. Use with the count parameter for pagination. There is no upper limit for offset; setting a large value may result in no results being returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "The user's search query term, which cannot be empty.", "in": "query", "name": "q", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "The value must be in host address format (e.g., baijiahao.baidu.com). Returns results only from the specified site(s).", "in": "query", "name": "sites", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "queryContext": { "properties": { "originalQuery": { "description": "The user's original search query", "type": "string" } }, "type": "object" }, "webPages": { "properties": { "value": { "description": "Detailed result data returned", "items": { "properties": { "content": { "description": "Long abstract information of the webpage, retrieved from the main text. MARKDOWN and HTML formats include image links with anchor positions", "type": "string" }, "contentCrawled": { "description": "Long abstract retrieval status: true for success (content is included in content), false for failure (content is empty)", "type": "boolean" }, "datePublished": { "description": "Page publication time (included in some sites) Example: 2025-07-14T01:15:00.0000000Z", "type": "string" }, "imageList": { "description": "List of image URLs in the webpage (included in some webpages, depending on whether the page contains images)", "type": "array" }, "logo": { "description": "Website logo (included in some webpages)", "type": "string" }, "mainText": { "description": "Dynamic abstract fragment extracted from the text, most relevant to the query. More intelligent than snippet", "type": "string" }, "name": { "description": "Webpage title", "type": "string" }, "score": { "description": "Content relevance score", "type": "number" }, "siteName": { "description": "Website name (included in some webpages)", "type": "string" }, "snippet": { "description": "Text snippet describing the webpage content", "type": "string" }, "url": { "description": "Webpage URL", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Official typed response table; required fields and undeclared array item types are not inferred." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Perform Smart Search", "tags": [ "search" ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "1000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.001" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } }, "/apis/v1/airbnb/search": { "get": { "description": "\nPublished reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ.\n", "operationId": "youtube_5e7b3be832ec__any_youtube_apis_v1_airbnb_search", "parameters": [ { "description": "Number of adult guests", "in": "query", "name": "adults", "required": false, "schema": { "maximum": 16, "minimum": 0, "type": "integer" } }, { "description": "Airbnb domain to search (affects language and regional results)", "in": "query", "name": "airbnb_domain", "required": false, "schema": { "default": "airbnb.com", "type": "string" } }, { "description": "Comma-separated list of amenity keys (e.g., \"wifi,pool,kitchen\"). Supports hundreds of amenities including wifi, pool, kitchen, air_conditioning, heating, washer, dryer, parking, pets_allowed, wheelchair_accessible, gym, hot_tub, ev_charger, and many more. Also supports special filters: guest_favorite, instant_book, luxe.", "in": "query", "name": "amenities", "required": false, "schema": { "type": "string" } }, { "description": "Minimum number of bathrooms", "in": "query", "name": "bathrooms", "required": false, "schema": { "maximum": 8, "minimum": 0, "type": "integer" } }, { "description": "Minimum number of bedrooms", "in": "query", "name": "bedrooms", "required": false, "schema": { "maximum": 8, "minimum": 0, "type": "integer" } }, { "description": "Minimum number of beds", "in": "query", "name": "beds", "required": false, "schema": { "maximum": 8, "minimum": 0, "type": "integer" } }, { "description": "Geographic bounding box coordinates for map-based search. Format: [[ne_lat,ne_lng],[sw_lat,sw_lng]]. Either q or bounding_box is required.", "in": "query", "name": "bounding_box", "required": false, "schema": { "type": "string" } }, { "description": "Check-in date in YYYY-MM-DD format. Must be a future date. Cannot be used together with time_period.", "in": "query", "name": "check_in_date", "required": false, "schema": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, { "description": "Check-out date in YYYY-MM-DD format. Must be after check-in date. Requires check_in_date to be set.", "in": "query", "name": "check_out_date", "required": false, "schema": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, { "description": "Number of children guests", "in": "query", "name": "children", "required": false, "schema": { "maximum": 15, "minimum": 0, "type": "integer" } }, { "description": "Currency code for pricing. Defaults to USD on airbnb.com; country-specific domains use their own local currency unless this parameter is set.", "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "enum": [ "USD", "AUD", "BRL", "BGN", "BAM", "CAD", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "AED", "EUR", "GHS", "GTQ", "HNL", "HKD", "HUF", "INR", "IDR", "ILS", "JPY", "KZT", "KES", "MYR", "MXN", "MAD", "TWD", "NZD", "NOK", "PEN", "PHP", "PLN", "GBP", "QAR", "RON", "RUB", "SAR", "SGD", "ZAR", "KRW", "SEK", "CHF", "THB", "TRY", "UGX", "UAH", "UYU", "VND" ], "type": "string" } }, { "description": "Search engine identifier", "example": "airbnb", "in": "query", "name": "engine", "required": true, "schema": { "enum": [ "airbnb" ], "type": "string" } }, { "description": "When `true`, returns tax-inclusive search-card pricing. Each property's `price` then carries `total_with_taxes` and itemizes its tax lines in `breakdown`, without any extra per-property call. Applies to airbnb.com, where taxes normally appear only at checkout; other country-specific domains are unaffected (many, like EU domains, already show tax-inclusive totals by default). The nightly prices are the same as the default response; taxes are itemized on top.", "in": "query", "name": "include_taxes", "required": false, "schema": { "default": "false", "enum": [ "true", "false" ], "type": "string" } }, { "description": "Number of infant guests", "in": "query", "name": "infants", "required": false, "schema": { "maximum": 5, "minimum": 0, "type": "integer" } }, { "description": "Token for pagination to retrieve subsequent pages of results", "in": "query", "name": "next_page_token", "required": false, "schema": { "type": "string" } }, { "description": "Number of pets", "in": "query", "name": "pets", "required": false, "schema": { "maximum": 5, "minimum": 0, "type": "integer" } }, { "description": "Maximum price filter per night", "in": "query", "name": "price_max", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "description": "Minimum price filter per night", "in": "query", "name": "price_min", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of property type keys", "in": "query", "name": "property_types", "required": false, "schema": { "type": "string" } }, { "description": "Search query for location (e.g., \"Barcelona\", \"Paris\"). Either q or bounding_box is required.", "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "description": "Flexible trip length for searches without specific dates. Cannot be used together with check_in_date.", "in": "query", "name": "time_period", "required": false, "schema": { "default": "one_week", "enum": [ "weekend_trip", "one_week", "one_month" ], "type": "string" } }, { "description": "Type of accommodation", "in": "query", "name": "type_of_place", "required": false, "schema": { "enum": [ "any", "room", "entire_home" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchResponse" } } }, "description": "Successful response" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" }, "402": { "description": "Payment required. Inspect WWW-Authenticate for current terms.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "summary": "Search Airbnb Listings", "tags": [ "default" ], "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/airbnb/search?engine=airbnb' \\\n --header 'Authorization: Bearer '" } ], "x-payment-info": { "offers": [ { "method": "tempo", "intent": "charge", "amount": "1000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "AISA API request. Use an API key (Authorization: Bearer sk-...) or complete the MPP payment challenge." } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.001" }, "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "0x20C000000000000000000000b9537d11c60E8b50" } } ] } } } }, "components": { "schemas": { "brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__Extra": { "properties": { "might_be_offensive": { "default": false, "description": "Indicates whether the image search results might contain offensive content.", "title": "Might Be Offensive", "type": "boolean" } }, "title": "Extra", "type": "object" }, "brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__Query": { "properties": { "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The altered query by the spellchecker. This is the query that is used to search.", "title": "Altered" }, "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.", "title": "Show Strict Warning" }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the spellchecker is enabled or disabled.", "title": "Spellcheck Off" } }, "required": [ "original" ], "title": "Query", "type": "object" }, "brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__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" }, "brave_search_d16c20eca148__Response762Cca4421D2_Properties": { "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The height of the image.", "title": "Height" }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The lower resolution placeholder image URL.", "title": "Placeholder" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The width of the image.", "title": "Width" } }, "title": "Properties", "type": "object" }, "brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__Thumbnail": { "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The height of the image.", "title": "Height" }, "src": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The served URL of the image.", "title": "Src" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The width of the image.", "title": "Width" } }, "title": "Thumbnail", "type": "object" }, "brave_search_d16c20eca148__Response762Cca4421D2_ImageResult": { "properties": { "confidence": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "description": "The confidence level for the image result.", "title": "Confidence" }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL associated with the image search result." }, "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" }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_Properties" }, { "type": "null" } ], "description": "Metadata for the image." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source domain where the image was found.", "title": "Source" }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail for the image." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the image.", "title": "Title" }, "type": { "default": "image_result", "description": "The type of image search API result. The value is always image_result.", "title": "Type", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original page URL where the image was found.", "title": "Url" } }, "title": "ImageResult", "type": "object" }, "brave_search_d16c20eca148__Response762Cca4421D2_ImageSearchApiResponse": { "properties": { "extra": { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__Extra", "description": "Additional information about the image search results." }, "query": { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_app__models__products__search__v1__images__Query", "description": "Image search query string." }, "results": { "description": "The list of image results for the given query.", "items": { "$ref": "#/components/schemas/brave_search_d16c20eca148__Response762Cca4421D2_ImageResult" }, "title": "Results", "type": "array" }, "type": { "const": "images", "default": "images", "enum": [ "images" ], "title": "Type", "type": "string" } }, "required": [ "query", "results", "extra" ], "title": "ImageSearchApiResponse", "type": "object" }, "brave_search_7826339177ff__Response762Cca4421D2_LLMContextItem": { "description": "A single LLM context item with URL, title, snippets, and optional last modified dates.", "properties": { "snippets": { "default": [], "description": "Extracted text chunks from the page that are picked for their relevance to the query.", "items": { "type": "string" }, "title": "Snippets", "type": "array" }, "title": { "default": "", "description": "The page title.", "title": "Title", "type": "string" }, "url": { "default": "", "description": "The source URL.", "title": "Url", "type": "string" } }, "title": "LLMContextItem", "type": "object" }, "brave_search_7826339177ff__Response762Cca4421D2_LLMContextMapItem": { "description": "A map/place item returned in the map array for local recall queries.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the place.", "title": "Name" }, "snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The snippets about the place.", "title": "Snippets" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the place.", "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL of the place.", "title": "Url" } }, "title": "LLMContextMapItem", "type": "object" }, "brave_search_7826339177ff__Response762Cca4421D2_LLMContextPOIItem": { "description": "A point of interest item returned in the poi array for local recall queries.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the point of interest.", "title": "Name" }, "snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The snippets about the point of interest.", "title": "Snippets" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the point of interest.", "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL of the point of interest.", "title": "Url" } }, "title": "LLMContextPOIItem", "type": "object" }, "brave_search_7826339177ff__Response762Cca4421D2_LLMContext": { "description": "Container for all LLM context content by type.", "properties": { "generic": { "default": [], "description": "Array of LLM context items with extracted web content.", "items": { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_LLMContextItem" }, "title": "Generic", "type": "array" }, "map": { "default": [], "description": "Map/place results. When enable_local is enabled, the response may include map data.", "items": { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_LLMContextMapItem" }, "title": "Map", "type": "array" }, "poi": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_LLMContextPOIItem" }, { "type": "null" } ], "description": "Point of interest data. When enable_local is enabled, the response may include POI data." } }, "title": "LLMContext", "type": "object" }, "brave_search_7826339177ff__Response762Cca4421D2_snakepit__models__search_api__specs__atomic__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" }, "brave_search_7826339177ff__Response762Cca4421D2_Source": { "description": "Minimal metadata for a referenced source URL.", "properties": { "age": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The page\u2019s date rendered four ways, in fixed positions: full date, YYYY-MM-DD, relative age, and an ISO 8601 timestamp. Empty when the page has no known date.", "title": "Age" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s own description, independent of the query (unlike snippet). Requires enable_source_metadata.", "title": "Description" }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the site\u2019s favicon image.", "title": "Favicon" }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Unix seconds of the index\u2019s last fetch of this page. Requires enable_source_metadata.", "title": "Fetched Content Timestamp" }, "hostname": { "default": "", "description": "The source hostname.", "title": "Hostname", "type": "string" }, "robotstxt_status": { "anyOf": [ { "enum": [ "allow", "disallow", "unknown" ], "type": "string" }, { "type": "null" } ], "description": "Robots.txt status for the requested user-agent: allow, disallow, or unknown.", "title": "Robotstxt Status" }, "site_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The site name (e.g. \u2018Wikipedia\u2019).", "title": "Site Name" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The most query-relevant passage of the source page.", "title": "Snippet" }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_snakepit__models__search_api__specs__atomic__Thumbnail" }, { "type": "null" } ], "description": "Page thumbnail: src is the proxied URL (ready to serve); original is the raw upstream URL." }, "title": { "default": "", "description": "The page title.", "title": "Title", "type": "string" } }, "title": "Source", "type": "object" }, "brave_search_7826339177ff__Response762Cca4421D2_LLMContextAPIResponse": { "description": "Response model for the LLM Context API (/v1/llm/context).", "properties": { "grounding": { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_LLMContext", "default": { "generic": [], "map": [] } }, "sources": { "additionalProperties": { "$ref": "#/components/schemas/brave_search_7826339177ff__Response762Cca4421D2_Source" }, "default": {}, "description": "Metadata for all referenced URLs, keyed by URL.", "title": "Sources", "type": "object" } }, "title": "LLMContextAPIResponse", "type": "object" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextItem": { "description": "A single LLM context item with URL, title, snippets, and optional last modified dates.", "properties": { "snippets": { "default": [], "description": "Extracted text chunks from the page that are picked for their relevance to the query.", "items": { "type": "string" }, "title": "Snippets", "type": "array" }, "title": { "default": "", "description": "The page title.", "title": "Title", "type": "string" }, "url": { "default": "", "description": "The source URL.", "title": "Url", "type": "string" } }, "title": "LLMContextItem", "type": "object" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextMapItem": { "description": "A map/place item returned in the map array for local recall queries.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the place.", "title": "Name" }, "snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The snippets about the place.", "title": "Snippets" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the place.", "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL of the place.", "title": "Url" } }, "title": "LLMContextMapItem", "type": "object" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextPOIItem": { "description": "A point of interest item returned in the poi array for local recall queries.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the point of interest.", "title": "Name" }, "snippets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The snippets about the point of interest.", "title": "Snippets" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The title of the point of interest.", "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL of the point of interest.", "title": "Url" } }, "title": "LLMContextPOIItem", "type": "object" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContext": { "description": "Container for all LLM context content by type.", "properties": { "generic": { "default": [], "description": "Array of LLM context items with extracted web content.", "items": { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextItem" }, "title": "Generic", "type": "array" }, "map": { "default": [], "description": "Map/place results. When enable_local is enabled, the response may include map data.", "items": { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextMapItem" }, "title": "Map", "type": "array" }, "poi": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextPOIItem" }, { "type": "null" } ], "description": "Point of interest data. When enable_local is enabled, the response may include POI data." } }, "title": "LLMContext", "type": "object" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_snakepit__models__search_api__specs__atomic__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" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_Source": { "description": "Minimal metadata for a referenced source URL.", "properties": { "age": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The page\u2019s date rendered four ways, in fixed positions: full date, YYYY-MM-DD, relative age, and an ISO 8601 timestamp. Empty when the page has no known date.", "title": "Age" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s own description, independent of the query (unlike snippet). Requires enable_source_metadata.", "title": "Description" }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the site\u2019s favicon image.", "title": "Favicon" }, "fetched_content_timestamp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Unix seconds of the index\u2019s last fetch of this page. Requires enable_source_metadata.", "title": "Fetched Content Timestamp" }, "hostname": { "default": "", "description": "The source hostname.", "title": "Hostname", "type": "string" }, "robotstxt_status": { "anyOf": [ { "enum": [ "allow", "disallow", "unknown" ], "type": "string" }, { "type": "null" } ], "description": "Robots.txt status for the requested user-agent: allow, disallow, or unknown.", "title": "Robotstxt Status" }, "site_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The site name (e.g. \u2018Wikipedia\u2019).", "title": "Site Name" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The most query-relevant passage of the source page.", "title": "Snippet" }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_snakepit__models__search_api__specs__atomic__Thumbnail" }, { "type": "null" } ], "description": "Page thumbnail: src is the proxied URL (ready to serve); original is the raw upstream URL." }, "title": { "default": "", "description": "The page title.", "title": "Title", "type": "string" } }, "title": "Source", "type": "object" }, "brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContextAPIResponse": { "description": "Response model for the LLM Context API (/v1/llm/context).", "properties": { "grounding": { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_LLMContext", "default": { "generic": [], "map": [] } }, "sources": { "additionalProperties": { "$ref": "#/components/schemas/brave_search_0e9bbdfa3b1e__Response762Cca4421D2_Source" }, "default": {}, "description": "Metadata for all referenced URLs, keyed by URL.", "title": "Sources", "type": "object" } }, "title": "LLMContextAPIResponse", "type": "object" }, "brave_search_a8042c2839ba__Response762Cca4421D2_LocationDescription": { "description": "AI generated description of a location result.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "AI generated description of the location with the given id.", "title": "Description" }, "id": { "description": "A temporary id of the location with this description.", "title": "Id", "type": "string" }, "type": { "const": "local_description", "default": "local_description", "description": "The type of a location description. The value is always local_description.", "enum": [ "local_description" ], "title": "Type", "type": "string" } }, "required": [ "id" ], "title": "LocationDescription", "type": "object" }, "brave_search_a8042c2839ba__Response762Cca4421D2_LocalDescriptionsSearchApiResponse": { "properties": { "results": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_a8042c2839ba__Response762Cca4421D2_LocationDescription" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "description": "The list of location descriptions for the given location identifiers.", "title": "Results" }, "type": { "const": "local_descriptions", "default": "local_descriptions", "enum": [ "local_descriptions" ], "title": "Type", "type": "string" } }, "title": "LocalDescriptionsSearchApiResponse", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_OpeningHours": { "description": "Opening hours of a business at a particular location.", "properties": { "current_day": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_DayOpeningHours" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "The opening hours for the whole week.", "title": "Days" } }, "title": "OpeningHours", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_PictureResults": { "description": "A model representing a list of pictures.", "properties": { "results": { "description": "A list of thumbnail results.", "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__MetaUrl", "description": "Aggregated information about the URL." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s 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/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_TripadvisorReview": { "description": "A model representing a Tripadvisor review.", "properties": { "author": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_Reviews": { "description": "The reviews associated with an entity.", "properties": { "results": { "description": "A list of trip advisor reviews for the entity.", "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_LocationResult": { "description": "A result that is location relevant.", "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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\u2019s 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/brave_search_0000e68d5a2c__Response762Cca4421D2_PictureResults" }, { "type": "null" } ], "description": "A bunch of pictures associated with the business." }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The ratings of the business." }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_LocationWebResult" }, "type": "array" }, { "type": "null" } ], "description": "Web results related to this location.", "title": "Results" }, "reviews": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_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/brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_AddressResult": { "description": "A result representing a street address or a street.", "properties": { "coordinates": { "description": "A pair of coordinates (lat, long) for the address.", "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "title": "Coordinates", "type": "array" }, "distance": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_Unit" }, { "type": "null" } ], "description": "Distance from the user\u2019s geolocation, if available." }, "name": { "description": "The name of the address.", "title": "Name", "type": "string" }, "pois": { "default": [], "description": "POIs located at this address.", "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_LocationResult" }, "title": "Pois", "type": "array" }, "pois_nearby": { "default": [], "description": "POIs located nearby this address.", "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_LocationResult" }, "title": "Pois Nearby", "type": "array" }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_PostalAddress" }, { "type": "null" } ], "description": "Structured postal address." }, "type": { "default": "address", "description": "Result type identifier. address when the result refers to an explicit street + number, street when it refers to the street itself.", "enum": [ "address", "street" ], "title": "Type", "type": "string" }, "zoom_level": { "default": 15, "description": "Suggested zoom level on the map.", "title": "Zoom Level", "type": "integer" } }, "required": [ "name", "coordinates" ], "title": "AddressResult", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_CityResult": { "description": "A result representing a city.", "properties": { "coordinates": { "description": "A pair of coordinates (lat, long) for the city.", "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "title": "Coordinates", "type": "array" }, "country": { "description": "The country of the city.", "title": "Country", "type": "string" }, "name": { "description": "The name of the city.", "title": "Name", "type": "string" }, "thumbnail": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the city." }, "type": { "const": "city", "default": "city", "description": "City result type identifier. The value is always city.", "enum": [ "city" ], "title": "Type", "type": "string" } }, "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "CityResult", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_CountryResult": { "description": "A result representing a country.", "properties": { "coordinates": { "description": "A pair of coordinates (lat, long) for the country.", "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "title": "Coordinates", "type": "array" }, "country": { "description": "The country of the result.", "title": "Country", "type": "string" }, "name": { "description": "The name of the country.", "title": "Name", "type": "string" }, "thumbnail": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the country." }, "type": { "const": "country", "default": "country", "description": "Country result type identifier. The value is always country.", "enum": [ "country" ], "title": "Type", "type": "string" } }, "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "CountryResult", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_snakepit__models__search_api__responses__local__v1__Location": { "properties": { "coordinates": { "description": "The latitude and longitude of the location.", "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "title": "Coordinates", "type": "array" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The two letter country code of the location.", "title": "Country" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the location.", "title": "Name" } }, "required": [ "coordinates" ], "title": "Location", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_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" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_NeighborhoodResult": { "description": "A result representing a neighborhood.", "properties": { "coordinates": { "description": "A pair of coordinates (lat, long) for the neighborhood.", "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "title": "Coordinates", "type": "array" }, "country": { "description": "The country of the neighborhood.", "title": "Country", "type": "string" }, "name": { "description": "The name of the neighborhood.", "title": "Name", "type": "string" }, "thumbnail": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the neighborhood." }, "type": { "const": "neighborhood", "default": "neighborhood", "description": "Neighborhood result type identifier. The value is always neighborhood.", "enum": [ "neighborhood" ], "title": "Type", "type": "string" } }, "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "NeighborhoodResult", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_snakepit__models__search_api__responses__local__v1__Query": { "properties": { "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The altered query by the spellchecker. This is the query that is used to search.", "title": "Altered" }, "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.", "title": "Show Strict Warning" }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the spellchecker is enabled or disabled.", "title": "Spellcheck Off" } }, "required": [ "original" ], "title": "Query", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_RegionResult": { "description": "A result representing a region (e.g. a state or province).", "properties": { "coordinates": { "description": "A pair of coordinates (lat, long) for the region.", "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "title": "Coordinates", "type": "array" }, "country": { "description": "The country of the region.", "title": "Country", "type": "string" }, "name": { "description": "The name of the region.", "title": "Name", "type": "string" }, "thumbnail": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail", "description": "Primary image for the region." }, "type": { "const": "region", "default": "region", "description": "Region result type identifier. The value is always region.", "enum": [ "region" ], "title": "Type", "type": "string" } }, "required": [ "name", "country", "coordinates", "thumbnail" ], "title": "RegionResult", "type": "object" }, "brave_search_0000e68d5a2c__Response762Cca4421D2_LocalPlaceSearchApiResponse": { "properties": { "addresses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_AddressResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of address results for the given query.", "title": "Addresses" }, "cities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_CityResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of city results for the given query.", "title": "Cities" }, "countries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_CountryResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of country results for the given query.", "title": "Countries" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_snakepit__models__search_api__responses__local__v1__Location" }, { "type": "null" } ], "description": "Information about location resolved from either the coordinates of the location string." }, "mixed": { "default": [], "description": "The list of mixed results for the given query.", "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_ResultReference" }, "title": "Mixed", "type": "array" }, "neighborhoods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_NeighborhoodResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of neighborhood results for the given query.", "title": "Neighborhoods" }, "query": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_snakepit__models__search_api__responses__local__v1__Query" }, { "type": "null" } ], "description": "The query object containing the original and potentially spell-corrected query." }, "regions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_RegionResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of region results for the given query.", "title": "Regions" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_LocationResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of points of interest results for the given quer.", "title": "Results" }, "streets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_0000e68d5a2c__Response762Cca4421D2_AddressResult" }, "type": "array" }, { "type": "null" } ], "description": "The list of street results for the given query.", "title": "Streets" }, "type": { "const": "locations", "default": "locations", "enum": [ "locations" ], "title": "Type", "type": "string" } }, "title": "LocalPlaceSearchApiResponse", "type": "object" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_OpeningHours": { "description": "Opening hours of a business at a particular location.", "properties": { "current_day": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_DayOpeningHours" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "The opening hours for the whole week.", "title": "Days" } }, "title": "OpeningHours", "type": "object" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_PictureResults": { "description": "A model representing a list of pictures.", "properties": { "results": { "description": "A list of thumbnail results.", "items": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_app__models__products__search__v1__shared__MetaUrl", "description": "Aggregated information about the URL." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s 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/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_TripadvisorReview": { "description": "A model representing a Tripadvisor review.", "properties": { "author": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_Reviews": { "description": "The reviews associated with an entity.", "properties": { "results": { "description": "A list of trip advisor reviews for the entity.", "items": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_LocationResult": { "description": "A result that is location relevant.", "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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\u2019s 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/brave_search_7637e45b1e94__Response762Cca4421D2_PictureResults" }, { "type": "null" } ], "description": "A bunch of pictures associated with the business." }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The ratings of the business." }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_LocationWebResult" }, "type": "array" }, { "type": "null" } ], "description": "Web results related to this location.", "title": "Results" }, "reviews": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_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/brave_search_7637e45b1e94__Response762Cca4421D2_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" }, "brave_search_7637e45b1e94__Response762Cca4421D2_LocalPoiSearchApiResponse": { "properties": { "results": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_7637e45b1e94__Response762Cca4421D2_LocationResult" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "description": "The list of location results (POIs) for the given location identifiers.", "title": "Results" }, "type": { "const": "local_pois", "default": "local_pois", "enum": [ "local_pois" ], "title": "Type", "type": "string" } }, "title": "LocalPoiSearchApiResponse", "type": "object" }, "brave_search_c8e02c744dde__Response762Cca4421D2_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" }, "brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__Query": { "properties": { "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The altered query by the spellchecker. This is the query that is used to search if any.", "title": "Altered" }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cleaned normalized query by the spellchecker. This is the query that is used to search if any.", "title": "Cleaned" }, "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_SearchOperators" }, { "type": "null" } ], "description": "Search operators applied to the query." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.", "title": "Show Strict Warning" }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the spellchecker is enabled or disabled.", "title": "Spellcheck Off" } }, "required": [ "original" ], "title": "Query", "type": "object" }, "brave_search_c8e02c744dde__Response762Cca4421D2_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" }, "brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__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" }, "brave_search_c8e02c744dde__Response762Cca4421D2_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" }, "brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__Thumbnail": { "properties": { "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original URL of the thumbnail associated with the news article.", "title": "Original" }, "src": { "description": "The served URL of the thumbnail associated with the news article.", "title": "Src", "type": "string" } }, "required": [ "src" ], "title": "Thumbnail", "type": "object" }, "brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__NewsResult": { "properties": { "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A human-readable representation of the news article\u2019s age. For example, 2 days ago.", "title": "Age" }, "breaking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the result includes breaking news.", "title": "Breaking" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description for the news article.", "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" }, "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/brave_search_c8e02c744dde__Response762Cca4421D2_PostprocessedIcon" }, "type": "array" }, { "type": "null" } ], "description": "Icons associated with the news result.", "title": "Icons" }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL associated with the news search result." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s 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" }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail for the news article." }, "title": { "description": "The title of the news article.", "title": "Title", "type": "string" }, "type": { "const": "news_result", "default": "news_result", "description": "The type of news search API result. The value is always news_result.", "enum": [ "news_result" ], "title": "Type", "type": "string" }, "url": { "description": "The source URL of the news article.", "title": "Url", "type": "string" } }, "required": [ "title", "url" ], "title": "NewsResult", "type": "object" }, "brave_search_c8e02c744dde__Response762Cca4421D2_NewsSearchApiResponse": { "properties": { "query": { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__Query", "description": "News search query string." }, "results": { "default": [], "description": "The list of news results for the given query.", "items": { "$ref": "#/components/schemas/brave_search_c8e02c744dde__Response762Cca4421D2_app__models__products__search__v1__news__NewsResult" }, "title": "Results", "type": "array" }, "type": { "const": "news", "default": "news", "enum": [ "news" ], "title": "Type", "type": "string" } }, "required": [ "query" ], "title": "NewsSearchApiResponse", "type": "object" }, "brave_search_2321b7aba760__Response762Cca4421D2_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" }, "brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__Query": { "properties": { "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The altered query by the spellchecker. This is the query that is used to search if any.", "title": "Altered" }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cleaned normalized query by the spellchecker. This is the query that is used to search if any.", "title": "Cleaned" }, "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_SearchOperators" }, { "type": "null" } ], "description": "Search operators applied to the query." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.", "title": "Show Strict Warning" }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the spellchecker is enabled or disabled.", "title": "Spellcheck Off" } }, "required": [ "original" ], "title": "Query", "type": "object" }, "brave_search_2321b7aba760__Response762Cca4421D2_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" }, "brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__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" }, "brave_search_2321b7aba760__Response762Cca4421D2_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" }, "brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__Thumbnail": { "properties": { "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original URL of the thumbnail associated with the news article.", "title": "Original" }, "src": { "description": "The served URL of the thumbnail associated with the news article.", "title": "Src", "type": "string" } }, "required": [ "src" ], "title": "Thumbnail", "type": "object" }, "brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__NewsResult": { "properties": { "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A human-readable representation of the news article\u2019s age. For example, 2 days ago.", "title": "Age" }, "breaking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the result includes breaking news.", "title": "Breaking" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description for the news article.", "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" }, "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/brave_search_2321b7aba760__Response762Cca4421D2_PostprocessedIcon" }, "type": "array" }, { "type": "null" } ], "description": "Icons associated with the news result.", "title": "Icons" }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__MetaUrl" }, { "type": "null" } ], "description": "Aggregated information on the URL associated with the news search result." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s 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" }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__Thumbnail" }, { "type": "null" } ], "description": "The thumbnail for the news article." }, "title": { "description": "The title of the news article.", "title": "Title", "type": "string" }, "type": { "const": "news_result", "default": "news_result", "description": "The type of news search API result. The value is always news_result.", "enum": [ "news_result" ], "title": "Type", "type": "string" }, "url": { "description": "The source URL of the news article.", "title": "Url", "type": "string" } }, "required": [ "title", "url" ], "title": "NewsResult", "type": "object" }, "brave_search_2321b7aba760__Response762Cca4421D2_NewsSearchApiResponse": { "properties": { "query": { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__Query", "description": "News search query string." }, "results": { "default": [], "description": "The list of news results for the given query.", "items": { "$ref": "#/components/schemas/brave_search_2321b7aba760__Response762Cca4421D2_app__models__products__search__v1__news__NewsResult" }, "title": "Results", "type": "array" }, "type": { "const": "news", "default": "news", "enum": [ "news" ], "title": "Type", "type": "string" } }, "required": [ "query" ], "title": "NewsSearchApiResponse", "type": "object" }, "brave_search_b5c877b4de0b__Response762Cca4421D2_OriginalQuery": { "properties": { "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" } }, "required": [ "original" ], "title": "OriginalQuery", "type": "object" }, "brave_search_b5c877b4de0b__Response762Cca4421D2_SpellCheckResult": { "properties": { "query": { "description": "The spellcheck-corrected query.", "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "SpellCheckResult", "type": "object" }, "brave_search_b5c877b4de0b__Response762Cca4421D2_SpellCheckSearchApiResponse": { "properties": { "query": { "$ref": "#/components/schemas/brave_search_b5c877b4de0b__Response762Cca4421D2_OriginalQuery", "description": "Spellcheck search query string. Only the original query is returned." }, "results": { "default": [], "description": "The list of spell-checked results for given query.", "items": { "$ref": "#/components/schemas/brave_search_b5c877b4de0b__Response762Cca4421D2_SpellCheckResult" }, "title": "Results", "type": "array" }, "type": { "const": "spellcheck", "default": "spellcheck", "enum": [ "spellcheck" ], "title": "Type", "type": "string" } }, "required": [ "query" ], "title": "SpellCheckSearchApiResponse", "type": "object" }, "brave_search_21ef24ae52d8__Response762Cca4421D2_OriginalQuery": { "properties": { "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" } }, "required": [ "original" ], "title": "OriginalQuery", "type": "object" }, "brave_search_21ef24ae52d8__Response762Cca4421D2_SuggestType": { "description": "

Kind tag on a rich suggestion entry.

\n

Open set: mixer emits these today, but we may add Rich Header verticals\nover time, so consumers must render an unrecognised value as plain text.

", "enum": [ "query", "entity", "calculator" ], "title": "SuggestType", "type": "string" }, "brave_search_21ef24ae52d8__Response762Cca4421D2_SuggestResult": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The suggested query enriched description.", "title": "Description" }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The suggested query enriched image URL.", "title": "Img" }, "is_entity": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the suggested enriched query is an entity. Deprecated: use type instead.", "title": "Is Entity" }, "query": { "description": "Suggested query completion.", "title": "Query", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The suggested query enriched title.", "title": "Title" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_21ef24ae52d8__Response762Cca4421D2_SuggestType" }, { "type": "null" } ], "description": "Kind of suggestion, currently query or entity. New kinds may be added, so treat an unrecognised value as a plain query suggestion." } }, "required": [ "query" ], "title": "SuggestResult", "type": "object" }, "brave_search_21ef24ae52d8__Response762Cca4421D2_SuggestSearchApiResponse": { "properties": { "query": { "$ref": "#/components/schemas/brave_search_21ef24ae52d8__Response762Cca4421D2_OriginalQuery", "description": "Suggest search query string. Only the original query is returned." }, "results": { "default": [], "description": "The list of suggestions for the given query.", "items": { "$ref": "#/components/schemas/brave_search_21ef24ae52d8__Response762Cca4421D2_SuggestResult" }, "title": "Results", "type": "array" }, "type": { "const": "suggest", "default": "suggest", "enum": [ "suggest" ], "title": "Type", "type": "string" } }, "required": [ "query" ], "title": "SuggestSearchApiResponse", "type": "object" }, "brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__Extra": { "properties": { "might_be_offensive": { "default": false, "description": "Indicates whether the video search results might contain offensive content.", "title": "Might Be Offensive", "type": "boolean" } }, "title": "Extra", "type": "object" }, "brave_search_21a06d13d0be__Response762Cca4421D2_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" }, "brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__Query": { "properties": { "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The altered query by the spellchecker. This is the query that is used to search if any.", "title": "Altered" }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cleaned normalized query by the spellchecker. This is the query that is used to search if any.", "title": "Cleaned" }, "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_21a06d13d0be__Response762Cca4421D2_SearchOperators" }, { "type": "null" } ], "description": "Search operators applied to the query." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.", "title": "Show Strict Warning" }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the spellchecker is enabled or disabled.", "title": "Spellcheck Off" } }, "required": [ "original" ], "title": "Query", "type": "object" }, "brave_search_21a06d13d0be__Response762Cca4421D2_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" }, "brave_search_21a06d13d0be__Response762Cca4421D2_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" }, "brave_search_21a06d13d0be__Response762Cca4421D2_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" }, "brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData": { "properties": { "author": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_21a06d13d0be__Response762Cca4421D2_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" }, "brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__VideoResult": { "properties": { "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A human-readable representation of the video\u2019s 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/brave_search_21a06d13d0be__Response762Cca4421D2_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\u2019s 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/brave_search_21a06d13d0be__Response762Cca4421D2_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/brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData" }, { "type": "null" } ], "description": "Metadata for the video." } }, "required": [ "url", "title" ], "title": "VideoResult", "type": "object" }, "brave_search_21a06d13d0be__Response762Cca4421D2_VideoSearchApiResponse": { "properties": { "extra": { "$ref": "#/components/schemas/brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__Extra", "description": "Additional information about the video search results." }, "query": { "$ref": "#/components/schemas/brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__Query", "description": "Video search query string." }, "results": { "default": [], "description": "The list of video results for the given query.", "items": { "$ref": "#/components/schemas/brave_search_21a06d13d0be__Response762Cca4421D2_app__models__products__search__v1__videos__VideoResult" }, "title": "Results", "type": "array" }, "type": { "const": "videos", "default": "videos", "enum": [ "videos" ], "title": "Type", "type": "string" } }, "required": [ "query", "extra" ], "title": "VideoSearchApiResponse", "type": "object" }, "brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__Extra": { "properties": { "might_be_offensive": { "default": false, "description": "Indicates whether the video search results might contain offensive content.", "title": "Might Be Offensive", "type": "boolean" } }, "title": "Extra", "type": "object" }, "brave_search_252245bec325__Response762Cca4421D2_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" }, "brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__Query": { "properties": { "altered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The altered query by the spellchecker. This is the query that is used to search if any.", "title": "Altered" }, "cleaned": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cleaned normalized query by the spellchecker. This is the query that is used to search if any.", "title": "Cleaned" }, "original": { "description": "The original query that was requested.", "title": "Original", "type": "string" }, "search_operators": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_252245bec325__Response762Cca4421D2_SearchOperators" }, { "type": "null" } ], "description": "Search operators applied to the query." }, "show_strict_warning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The value is true if the lack of results is due to a strict safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.", "title": "Show Strict Warning" }, "spellcheck_off": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the spellchecker is enabled or disabled.", "title": "Spellcheck Off" } }, "required": [ "original" ], "title": "Query", "type": "object" }, "brave_search_252245bec325__Response762Cca4421D2_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" }, "brave_search_252245bec325__Response762Cca4421D2_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" }, "brave_search_252245bec325__Response762Cca4421D2_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" }, "brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData": { "properties": { "author": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_252245bec325__Response762Cca4421D2_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" }, "brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__VideoResult": { "properties": { "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A human-readable representation of the video\u2019s 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/brave_search_252245bec325__Response762Cca4421D2_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\u2019s 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/brave_search_252245bec325__Response762Cca4421D2_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/brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData" }, { "type": "null" } ], "description": "Metadata for the video." } }, "required": [ "url", "title" ], "title": "VideoResult", "type": "object" }, "brave_search_252245bec325__Response762Cca4421D2_VideoSearchApiResponse": { "properties": { "extra": { "$ref": "#/components/schemas/brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__Extra", "description": "Additional information about the video search results." }, "query": { "$ref": "#/components/schemas/brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__Query", "description": "Video search query string." }, "results": { "default": [], "description": "The list of video results for the given query.", "items": { "$ref": "#/components/schemas/brave_search_252245bec325__Response762Cca4421D2_app__models__products__search__v1__videos__VideoResult" }, "title": "Results", "type": "array" }, "type": { "const": "videos", "default": "videos", "enum": [ "videos" ], "title": "Type", "type": "string" } }, "required": [ "query", "extra" ], "title": "VideoSearchApiResponse", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__mixer__general__Language": { "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" }, "brave_search_79e935d283f3__Response762Cca4421D2_SearchAPIVertical": { "enum": [ "calculator", "cryptocurrency", "currency", "definitions", "formula1", "packagetracker", "sports", "stocks", "unitconversion", "unixtimestamp", "weather" ], "title": "SearchAPIVertical", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_ResponseCallbackInfo": { "properties": { "callback_key": { "description": "The unique key for the callback.", "title": "Callback Key", "type": "string" }, "callback_status": { "description": "The status of the callback operation. The value is either success or failure.", "enum": [ "success", "failure" ], "title": "Callback Status", "type": "string" }, "search_lang": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__mixer__general__Language", "default": "en", "description": "The language used for the search." }, "vertical": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SearchAPIVertical" }, { "type": "null" } ], "description": "The vertical associated with the callback. For the full list of verticals supported see the Rich Vertical list." } }, "required": [ "callback_key", "callback_status" ], "title": "ResponseCallbackInfo", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind": { "enum": [ "today", "season_end", "season_start", "explicit" ], "title": "SportsDateKind", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore": { "properties": { "away": { "title": "Away", "type": "integer" }, "home": { "title": "Home", "type": "integer" } }, "required": [ "home", "away" ], "title": "SportsFixtureScore", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballScoreTable": { "properties": { "ot": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q1": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q2": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q3": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q4": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] } }, "title": "SportsAmericanFootballScoreTable", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureStatusCode": { "enum": [ "FT", "AET", "Q1", "Q2", "Q3", "Q4", "NS", "POST", "CANC", "INT", "DEL", "LIVE", "FFA", "FFH", "FFB" ], "title": "SportsAmericanFootballFixtureStatusCode", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureStatusCode" }, { "type": "null" } ] }, "elapsed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Elapsed" } }, "title": "SportsAmericanFootballFixtureStatus", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "logo": { "title": "Logo", "type": "string" }, "name": { "title": "Name", "type": "string" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" } }, "required": [ "name", "logo" ], "title": "SportsTeam", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams": { "properties": { "away": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "home": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "home", "away" ], "title": "SportsFixtureTeams", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo": { "properties": { "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration" }, "thumbnail": { "title": "Thumbnail", "type": "string" }, "type": { "default": "video", "enum": [ "video", "story" ], "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "thumbnail" ], "title": "SportsFixtureVideo", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureAmericanFootball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "phase": { "title": "Phase", "type": "string" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballScoreTable" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureStatus" }, { "type": "null" } ] }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo" }, { "type": "null" } ] } }, "required": [ "id", "teams", "start_time", "phase" ], "title": "SportsFixtureAmericanFootball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague": { "properties": { "has_standings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Standings" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Id" }, "logo": { "title": "Logo", "type": "string" }, "name": { "title": "Name", "type": "string" }, "round": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Round" }, "season": { "title": "Season", "type": "string" } }, "required": [ "id", "name", "logo", "season" ], "title": "SportsLeague", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentLeagueGames": { "properties": { "date": { "title": "Date", "type": "string" }, "date_kind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "game_times": { "items": { "type": "integer" }, "title": "Game Times", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureAmericanFootball" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_games", "default": "league_games", "enum": [ "league_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsAmericanFootballContentLeagueGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStanding": { "properties": { "conference_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conference Rank" }, "conference_seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conference Seed" }, "division_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Division Rank" }, "division_seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Division Seed" }, "games_behind": { "title": "Games Behind", "type": "string" }, "matches_drawn": { "title": "Matches Drawn", "type": "integer" }, "matches_lost": { "title": "Matches Lost", "type": "integer" }, "matches_won": { "title": "Matches Won", "type": "integer" }, "matches_won_percent": { "title": "Matches Won Percent", "type": "string" }, "points_against": { "title": "Points Against", "type": "integer" }, "points_for": { "title": "Points For", "type": "integer" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "team", "matches_won", "matches_drawn", "matches_lost", "matches_won_percent", "points_for", "points_against", "games_behind" ], "title": "SportsAmericanFootballStanding", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStandingsDivision": { "properties": { "name": { "title": "Name", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStanding" }, "title": "Standings", "type": "array" } }, "required": [ "name", "standings" ], "title": "SportsAmericanFootballStandingsDivision", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStandingsGroup": { "properties": { "group_name": { "title": "Group Name", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStandingsDivision" }, "title": "Standings", "type": "array" } }, "required": [ "group_name", "standings" ], "title": "SportsAmericanFootballStandingsGroup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentLeagueStandings": { "properties": { "default_group": { "title": "Default Group", "type": "integer" }, "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_standings", "default": "league_standings", "enum": [ "league_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "group_standings", "default_group" ], "title": "SportsAmericanFootballContentLeagueStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCompetition": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Id" }, "name": { "title": "Name", "type": "string" }, "season": { "title": "Season", "type": "string" } }, "required": [ "id", "name", "season" ], "title": "SportsCompetition", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentTeamGames": { "properties": { "competitions": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCompetition" }, "title": "Competitions", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureAmericanFootball" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_games", "default": "team_games", "enum": [ "team_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "games", "competitions" ], "title": "SportsAmericanFootballContentTeamGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentTeamStandings": { "properties": { "default_group": { "title": "Default Group", "type": "integer" }, "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_standings", "default": "team_standings", "enum": [ "team_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "group_standings", "default_group" ], "title": "SportsAmericanFootballContentTeamStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureBulletin": { "properties": { "text": { "title": "Text", "type": "string" } }, "required": [ "text" ], "title": "SportsAmericanFootballFixtureBulletin", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentFixture": { "properties": { "bulletins": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureBulletin" }, "type": "array" }, { "type": "null" } ], "title": "Bulletins" }, "event_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Title" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "phase": { "title": "Phase", "type": "string" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "score_table": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballScoreTable" }, "start_time": { "title": "Start Time", "type": "integer" }, "statistics": { "title": "Statistics", "type": "object" }, "status": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballFixtureStatus" }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "type": { "const": "fixture", "default": "fixture", "enum": [ "fixture" ], "title": "Type", "type": "string" }, "week": { "title": "Week", "type": "integer" } }, "required": [ "league", "id", "start_time", "teams", "status", "score_table", "statistics", "phase", "week" ], "title": "SportsAmericanFootballContentFixture", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsType": { "enum": [ "basketball", "baseball", "football", "american_football", "formula_1", "ice_hockey", "rugby", "tennis", "golf", "cricket" ], "title": "SportsType", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType": { "enum": [ "league", "team", "fixture" ], "title": "SportsDataType", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsView": { "enum": [ "games", "standings", "fixture", "bracket" ], "title": "SportsView", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsResultAmericanFootball": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentLeagueGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentLeagueStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentTeamGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentTeamStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsAmericanFootballContentFixture" } ], "title": "Content" }, "sport": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsType", "default": "american_football" }, "type": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType" }, "view": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsView" } }, "required": [ "type", "view", "content" ], "title": "SportsResultAmericanFootball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballInningScore": { "properties": { "away": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Away" }, "home": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Home" } }, "title": "SportsBaseballInningScore", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballScoreTable": { "properties": { "errors": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "extra": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballInningScore" }, { "type": "null" } ] }, "hits": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "innings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballInningScore" }, "title": "Innings", "type": "array" } }, "required": [ "innings" ], "title": "SportsBaseballScoreTable", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballFixtureStatusCode": { "enum": [ "FT", "NS", "POST", "CANC", "INTR", "ABD", "IN1", "IN2", "IN3", "IN4", "IN5", "IN6", "IN7", "IN8", "IN9" ], "title": "SportsBaseballFixtureStatusCode", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballFixtureStatusCode" }, { "type": "null" } ] } }, "title": "SportsBaseballFixtureStatus", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureBaseball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballScoreTable" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballFixtureStatus" }, { "type": "null" } ] }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo" }, { "type": "null" } ] } }, "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureBaseball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentLeagueGames": { "properties": { "date": { "title": "Date", "type": "string" }, "date_kind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "game_times": { "items": { "type": "integer" }, "title": "Game Times", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureBaseball" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_games", "default": "league_games", "enum": [ "league_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsBaseballContentLeagueGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballStanding": { "properties": { "form": { "title": "Form", "type": "string" }, "games_behind": { "title": "Games Behind", "type": "number" }, "matches_lost": { "title": "Matches Lost", "type": "integer" }, "matches_lost_pros": { "title": "Matches Lost Pros", "type": "string" }, "matches_played": { "title": "Matches Played", "type": "integer" }, "matches_won": { "title": "Matches Won", "type": "integer" }, "matches_won_pros": { "title": "Matches Won Pros", "type": "string" }, "rank": { "title": "Rank", "type": "integer" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "team", "rank", "matches_played", "matches_won", "matches_won_pros", "matches_lost", "matches_lost_pros", "games_behind", "form" ], "title": "SportsBaseballStanding", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballStandingsGroup": { "properties": { "group_name": { "title": "Group Name", "type": "string" }, "stage": { "title": "Stage", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballStanding" }, "title": "Standings", "type": "array" } }, "required": [ "group_name", "standings", "stage" ], "title": "SportsBaseballStandingsGroup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentLeagueStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_standings", "default": "league_standings", "enum": [ "league_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "group_standings" ], "title": "SportsBaseballContentLeagueStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentTeamGames": { "properties": { "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureBaseball" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_games", "default": "team_games", "enum": [ "team_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "games" ], "title": "SportsBaseballContentTeamGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentTeamStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_standings", "default": "team_standings", "enum": [ "team_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "group_standings" ], "title": "SportsBaseballContentTeamStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsResultBaseball": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentLeagueGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentLeagueStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentTeamGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBaseballContentTeamStandings" } ], "title": "Content" }, "sport": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsType", "default": "baseball" }, "type": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType" }, "view": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsView" } }, "required": [ "type", "view", "content" ], "title": "SportsResultBaseball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballScoreTable": { "properties": { "ot": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q1": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q2": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q3": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "q4": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] } }, "title": "SportsBasketballScoreTable", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballFixtureStatusCode": { "enum": [ "FT", "AOT", "NS", "POST", "CANC", "SUSP", "Q1", "Q2", "Q3", "Q4", "BT", "OT", "HT" ], "title": "SportsBasketballFixtureStatusCode", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballFixtureStatusCode" }, { "type": "null" } ] } }, "title": "SportsBasketballFixtureStatus", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureBasketball": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballScoreTable" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballFixtureStatus" }, { "type": "null" } ] }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo" }, { "type": "null" } ] } }, "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureBasketball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentLeagueGames": { "properties": { "date": { "title": "Date", "type": "string" }, "date_kind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "game_times": { "items": { "type": "integer" }, "title": "Game Times", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureBasketball" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_games", "default": "league_games", "enum": [ "league_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsBasketballContentLeagueGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballStanding": { "properties": { "games_behind": { "title": "Games Behind", "type": "number" }, "matches_lost": { "title": "Matches Lost", "type": "integer" }, "matches_lost_pros": { "title": "Matches Lost Pros", "type": "string" }, "matches_played": { "title": "Matches Played", "type": "integer" }, "matches_won": { "title": "Matches Won", "type": "integer" }, "matches_won_pros": { "title": "Matches Won Pros", "type": "string" }, "rank": { "title": "Rank", "type": "integer" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "team", "rank", "matches_played", "matches_won", "matches_won_pros", "matches_lost", "matches_lost_pros", "games_behind" ], "title": "SportsBasketballStanding", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballStandingsGroup": { "properties": { "group_name": { "title": "Group Name", "type": "string" }, "stage": { "title": "Stage", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballStanding" }, "title": "Standings", "type": "array" } }, "required": [ "group_name", "standings", "stage" ], "title": "SportsBasketballStandingsGroup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentLeagueStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_standings", "default": "league_standings", "enum": [ "league_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "group_standings" ], "title": "SportsBasketballContentLeagueStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentTeamGames": { "properties": { "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureBasketball" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_games", "default": "team_games", "enum": [ "team_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "games" ], "title": "SportsBasketballContentTeamGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentTeamStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_standings", "default": "team_standings", "enum": [ "team_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "group_standings" ], "title": "SportsBasketballContentTeamStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsResultBasketball": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentLeagueGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentLeagueStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentTeamGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsBasketballContentTeamStandings" } ], "title": "Content" }, "sport": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsType", "default": "basketball" }, "type": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType" }, "view": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsView" } }, "required": [ "type", "view", "content" ], "title": "SportsResultBasketball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_CalculatorResult": { "properties": { "answer": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Answer" }, "expression": { "title": "Expression", "type": "string" } }, "required": [ "expression" ], "title": "CalculatorResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureScore": { "properties": { "away": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Away" }, "away_overs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Away Overs" }, "away_runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Away Runs" }, "home": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Home" }, "home_overs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Home Overs" }, "home_runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Home Runs" } }, "required": [ "home", "away" ], "title": "SportsCricketFixtureScore", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureStatusCode": { "enum": [ "ABN", "BRK", "FT", "LIVE", "NS", "PST", "SDL", "SPR", "STM", "TRB" ], "title": "SportsCricketFixtureStatusCode", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureStatusCode" }, { "type": "null" } ] } }, "title": "SportsCricketFixtureStatus", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureCricket": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureScore" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureStatus" }, { "type": "null" } ] }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo" }, { "type": "null" } ] } }, "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureCricket", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentLeagueGames": { "properties": { "date": { "title": "Date", "type": "string" }, "date_kind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "game_times": { "items": { "type": "integer" }, "title": "Game Times", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureCricket" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_games", "default": "league_games", "enum": [ "league_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsCricketContentLeagueGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketStanding": { "properties": { "matches_drawn": { "title": "Matches Drawn", "type": "string" }, "matches_lost": { "title": "Matches Lost", "type": "integer" }, "matches_no_result": { "title": "Matches No Result", "type": "string" }, "matches_played": { "title": "Matches Played", "type": "integer" }, "matches_won": { "title": "Matches Won", "type": "integer" }, "net_run_rate": { "title": "Net Run Rate", "type": "number" }, "points": { "title": "Points", "type": "string" }, "rank": { "title": "Rank", "type": "integer" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "team", "rank", "matches_played", "matches_won", "matches_drawn", "matches_lost", "matches_no_result", "points", "net_run_rate" ], "title": "SportsCricketStanding", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketStandingsGroup": { "properties": { "group_name": { "title": "Group Name", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketStanding" }, "title": "Standings", "type": "array" } }, "required": [ "group_name", "standings" ], "title": "SportsCricketStandingsGroup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentLeagueStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_standings", "default": "league_standings", "enum": [ "league_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "group_standings" ], "title": "SportsCricketContentLeagueStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentTeamGames": { "properties": { "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureCricket" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_games", "default": "team_games", "enum": [ "team_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "games" ], "title": "SportsCricketContentTeamGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentTeamStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_standings", "default": "team_standings", "enum": [ "team_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "group_standings" ], "title": "SportsCricketContentTeamStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBatter": { "properties": { "ballsFaced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ballsfaced" }, "bowledById": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bowledbyid" }, "caughtById": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caughtbyid" }, "day": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Day" }, "dismissalId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dismissalid" }, "foursScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Foursscored" }, "howOut": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Howout" }, "id": { "title": "Id", "type": "string" }, "minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minutes" }, "nonStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nonstrike" }, "onStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Onstrike" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "runsScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runsscored" }, "sixesScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sixesscored" } }, "required": [ "id" ], "title": "SportsCricketContentFixtureDetailsInningBatter", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBatters": { "properties": { "batter": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBatter" }, "title": "Batter", "type": "array" } }, "title": "SportsCricketContentFixtureDetailsInningBatters", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBowler": { "properties": { "ballsBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ballsbowled" }, "dotBalls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dotballs" }, "id": { "title": "Id", "type": "string" }, "maidensBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maidensbowled" }, "noBalls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Noballs" }, "nonStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nonstrike" }, "onStrike": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Onstrike" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "oversBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Oversbowled" }, "runsConceded": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runsconceded" }, "totalBallsBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalballsbowled" }, "wicketsTaken": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wicketstaken" }, "wides": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wides" } }, "required": [ "id" ], "title": "SportsCricketContentFixtureDetailsInningBowler", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBowlers": { "properties": { "bowler": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBowler" }, "title": "Bowler", "type": "array" } }, "title": "SportsCricketContentFixtureDetailsInningBowlers", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningExtras": { "properties": { "byes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Byes" }, "legByes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Legbyes" }, "noBalls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Noballs" }, "penalties": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Penalties" }, "totalExtras": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalextras" }, "wides": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wides" } }, "title": "SportsCricketContentFixtureDetailsInningExtras", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningFallOfWicket": { "properties": { "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "overBall": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overball" }, "playerId": { "title": "Playerid", "type": "string" }, "runs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runs" }, "totalBallsBowled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalballsbowled" } }, "required": [ "playerId" ], "title": "SportsCricketContentFixtureDetailsInningFallOfWicket", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningFallOfWickets": { "properties": { "fallOfWicket": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningFallOfWicket" }, "title": "Fallofwicket", "type": "array" } }, "title": "SportsCricketContentFixtureDetailsInningFallOfWickets", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningTeam": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "logo": { "title": "Logo", "type": "string" }, "name": { "title": "Name", "type": "string" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "overs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overs" }, "runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs" }, "score": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Score" } }, "required": [ "name", "logo" ], "title": "SportsCricketContentFixtureDetailsInningTeam", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningTotal": { "properties": { "overs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overs" }, "runsScored": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runsscored" }, "wickets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wickets" } }, "title": "SportsCricketContentFixtureDetailsInningTotal", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInning": { "properties": { "batters": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBatters" }, { "type": "null" } ] }, "battingTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Battingteamid" }, "bestBatters": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBatter" }, "title": "Bestbatters", "type": "array" }, "bestBowlers": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBowler" }, "title": "Bestbowlers", "type": "array" }, "bowlers": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningBowlers" }, { "type": "null" } ] }, "bowlingTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bowlingteamid" }, "declared": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Declared" }, "dlOvers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dlovers" }, "dlTarget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dltarget" }, "extras": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningExtras" }, { "type": "null" } ] }, "fallOfWickets": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningFallOfWickets" }, { "type": "null" } ] }, "followOn": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followon" }, "forfeited": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Forfeited" }, "id": { "title": "Id", "type": "integer" }, "overnightRuns": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overnightruns" }, "overnightWickets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overnightwickets" }, "team": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningTeam" }, { "type": "null" } ] }, "total": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInningTotal" }, { "type": "null" } ] } }, "required": [ "id" ], "title": "SportsCricketContentFixtureDetailsInning", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetails": { "properties": { "awayBattingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Awaybattingbonus" }, "awayBowlingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Awaybowlingbonus" }, "dl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dl" }, "homeBattingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Homebattingbonus" }, "homeBowlingBonus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Homebowlingbonus" }, "innings": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetailsInning" }, "title": "Innings", "type": "array" }, "matchDay": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Matchday" }, "minOversRemaining": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Minoversremaining" }, "night": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Night" }, "numberDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Numberdays" }, "playerOfTheMatch1Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch1Id" }, "playerOfTheMatch1Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch1Name" }, "playerOfTheMatch2Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch2Id" }, "playerOfTheMatch2Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playerofthematch2Name" }, "playerOfTheSeries1Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries1Id" }, "playerOfTheSeries1Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries1Name" }, "playerOfTheSeries2Id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries2Id" }, "playerOfTheSeries2Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playeroftheseries2Name" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" }, "statusId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Statusid" }, "toss": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Toss" }, "tossDecision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tossdecision" }, "tossWinnerTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tosswinnerteamid" }, "totalOvers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Totalovers" }, "winMargin": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Winmargin" }, "winTypeId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wintypeid" }, "winnerId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Winnerid" } }, "title": "SportsCricketContentFixtureDetails", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureLineupPlayer": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "gameRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gamerole" }, "id": { "title": "Id", "type": "string" }, "initials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initials" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "matchName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Matchname" }, "middleName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middlename" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "teamRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Teamrole" } }, "required": [ "id" ], "title": "SportsCricketContentFixtureLineupPlayer", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureLineup": { "properties": { "name": { "title": "Name", "type": "string" }, "player": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureLineupPlayer" }, "title": "Player", "type": "array" } }, "required": [ "name" ], "title": "SportsCricketContentFixtureLineup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixture": { "properties": { "details": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureDetails" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "lineups": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixtureLineup" }, "title": "Lineups", "type": "array" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureScore" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketFixtureStatus" }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "type": { "const": "fixture", "default": "fixture", "enum": [ "fixture" ], "title": "Type", "type": "string" }, "upcoming": { "title": "Upcoming", "type": "boolean" }, "venue_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Venue Name" } }, "required": [ "league", "id", "start_time", "teams", "status", "upcoming", "details", "lineups" ], "title": "SportsCricketContentFixture", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsResultCricket": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentLeagueGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentLeagueStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentTeamGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentTeamStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCricketContentFixture" } ], "title": "Content" }, "sport": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsType", "default": "cricket" }, "type": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType" }, "view": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsView" } }, "required": [ "type", "view", "content" ], "title": "SportsResultCricket", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_CurrencyForex": { "properties": { "code": { "title": "Code", "type": "string" }, "decimals": { "title": "Decimals", "type": "integer" }, "full_name": { "title": "Full Name", "type": "string" } }, "required": [ "full_name", "code", "decimals" ], "title": "CurrencyForex", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__cryptocurrencies__v1__Quote": { "properties": { "ath": { "title": "Ath", "type": "number" }, "ath_change_percentage": { "title": "Ath Change Percentage", "type": "number" }, "ath_date": { "title": "Ath Date", "type": "string" }, "atl": { "title": "Atl", "type": "number" }, "atl_change_percentage": { "title": "Atl Change Percentage", "type": "number" }, "atl_date": { "title": "Atl Date", "type": "string" }, "circulating_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Circulating Supply" }, "current_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Price" }, "fully_diluted_valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fully Diluted Valuation" }, "high_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High 24H" }, "id": { "title": "Id", "type": "string" }, "image": { "title": "Image", "type": "string" }, "last_updated": { "title": "Last Updated", "type": "string" }, "low_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low 24H" }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap" }, "market_cap_change_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap Change 24H" }, "market_cap_change_percentage_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap Change Percentage 24H" }, "market_cap_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Market Cap Rank" }, "max_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Supply" }, "name": { "title": "Name", "type": "string" }, "price_change_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Change 24H" }, "price_change_percentage_24h": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Change Percentage 24H" }, "symbol": { "title": "Symbol", "type": "string" }, "total_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Supply" }, "total_volume": { "title": "Total Volume", "type": "number" } }, "required": [ "id", "symbol", "name", "image", "current_price", "market_cap", "market_cap_rank", "total_volume", "high_24h", "low_24h", "price_change_24h", "price_change_percentage_24h", "market_cap_change_24h", "market_cap_change_percentage_24h", "ath", "ath_change_percentage", "ath_date", "atl", "atl_change_percentage", "atl_date", "last_updated" ], "title": "Quote", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TickerPlotTimeRange": { "enum": [ "1d", "5d", "7d", "1m", "3m", "6m", "ytd", "1y", "2y", "5y", "max" ], "title": "TickerPlotTimeRange", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_CryptocurrencyResultTimeseries": { "properties": { "time_range": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TickerPlotTimeRange" }, "ts_market_cap": { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "number" } ], "type": "array" }, "title": "Ts Market Cap", "type": "array" }, "ts_price": { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "number" } ], "type": "array" }, "title": "Ts Price", "type": "array" }, "ts_volume": { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "number" } ], "type": "array" }, "title": "Ts Volume", "type": "array" } }, "required": [ "time_range", "ts_price", "ts_market_cap", "ts_volume" ], "title": "CryptocurrencyResultTimeseries", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_CryptocurrencyItem": { "properties": { "label": { "title": "Label", "type": "string" }, "symbol": { "title": "Symbol", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "label", "value", "symbol" ], "title": "CryptocurrencyItem", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_VsCurrency": { "description": "

These are currencies or cryptocurrencies that the cryptocurrency is\ncompared to. e.g. BTC, ETH, USD, EUR, etc.

", "properties": { "label": { "title": "Label", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "label", "value" ], "title": "VsCurrency", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_CryptocurrencyResult": { "properties": { "amount": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Amount" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CurrencyForex" }, { "type": "null" } ] }, "intent_type": { "enum": [ "lookup", "conversion" ], "title": "Intent Type", "type": "string" }, "quote": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__cryptocurrencies__v1__Quote" }, "timeseries": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CryptocurrencyResultTimeseries" }, "top100_crypto": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CryptocurrencyItem" }, "title": "Top100 Crypto", "type": "array" }, "vs_currencies": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_VsCurrency" }, "title": "Vs Currencies", "type": "array" }, "vs_currency": { "title": "Vs Currency", "type": "string" } }, "required": [ "intent_type", "quote", "timeseries", "vs_currency" ], "title": "CryptocurrencyResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Info": { "properties": { "rate": { "title": "Rate", "type": "number" }, "timestamp": { "title": "Timestamp", "type": "integer" } }, "required": [ "rate", "timestamp" ], "title": "Info", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Currency": { "properties": { "code": { "title": "Code", "type": "string" }, "decimals": { "title": "Decimals", "type": "integer" }, "full_name": { "title": "Full Name", "type": "string" } }, "required": [ "full_name", "code", "decimals" ], "title": "Currency", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__currencies__v1__Query": { "properties": { "amount": { "title": "Amount", "type": "number" }, "from_currency": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Currency" }, "to_currency": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Currency" } }, "required": [ "from_currency", "to_currency", "amount" ], "title": "Query", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Conversion": { "properties": { "amount": { "title": "Amount", "type": "number" }, "date": { "title": "Date", "type": "string" }, "info": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Info" }, "query": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__currencies__v1__Query" }, "result": { "title": "Result", "type": "number" } }, "required": [ "query", "info", "date", "result", "amount" ], "title": "Conversion", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Timeseries": { "properties": { "time_range": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TickerPlotTimeRange" }, "ts_exchange_rate": { "default": [], "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "number" } ], "type": "array" }, "title": "Ts Exchange Rate", "type": "array" } }, "required": [ "time_range" ], "title": "Timeseries", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_CurrencyResult": { "properties": { "conversion": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Conversion" }, "supported_currencies": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Currency" }, "title": "Supported Currencies", "type": "array" }, "timeseries": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Timeseries" } }, "required": [ "conversion", "timeseries" ], "title": "CurrencyResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_DefinitionLabel": { "properties": { "text": { "title": "Text", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "text", "type" ], "title": "DefinitionLabel", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_DefinitionText": { "properties": { "example_uses": { "items": { "type": "string" }, "title": "Example Uses", "type": "array" }, "labels": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_DefinitionLabel" }, "title": "Labels", "type": "array" }, "related_words": { "items": { "type": "string" }, "title": "Related Words", "type": "array" }, "text": { "title": "Text", "type": "string" } }, "required": [ "text", "example_uses", "related_words", "labels" ], "title": "DefinitionText", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Definition": { "properties": { "definitions": { "items": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_DefinitionText" }, { "type": "string" } ] }, "title": "Definitions", "type": "array" }, "part_of_speech": { "title": "Part Of Speech", "type": "string" } }, "required": [ "part_of_speech", "definitions" ], "title": "Definition", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_DefinitionsResult": { "properties": { "attribution_text": { "title": "Attribution Text", "type": "string" }, "attribution_url": { "title": "Attribution Url", "type": "string" }, "audio_available": { "default": false, "title": "Audio Available", "type": "boolean" }, "definitions": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Definition" }, "title": "Definitions", "type": "array" }, "language": { "title": "Language", "type": "string" }, "pronounciation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pronounciation" }, "source_dict": { "title": "Source Dict", "type": "string" }, "word": { "title": "Word", "type": "string" } }, "required": [ "word", "language", "definitions", "source_dict", "attribution_text", "attribution_url" ], "title": "DefinitionsResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureAggregateScore": { "properties": { "scores": { "additionalProperties": { "type": "integer" }, "title": "Scores", "type": "object" } }, "required": [ "scores" ], "title": "SportsFixtureAggregateScore", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureEvent": { "properties": { "assist_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assist Name" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "elapsed": { "title": "Elapsed", "type": "integer" }, "extra": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Extra" }, "player_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Player Name" }, "team_id": { "title": "Team Id", "type": "integer" }, "type": { "title": "Type", "type": "string" } }, "required": [ "team_id", "type", "elapsed" ], "title": "SportsFootballFixtureEvent", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballCoach": { "properties": { "name": { "title": "Name", "type": "string" }, "photo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Photo" } }, "required": [ "name" ], "title": "SportsFootballCoach", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballPlayer": { "properties": { "grid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grid" }, "name": { "title": "Name", "type": "string" }, "number": { "title": "Number", "type": "integer" }, "photo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Photo" }, "pos": { "title": "Pos", "type": "string" } }, "required": [ "name", "number", "pos" ], "title": "SportsFootballPlayer", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballLineup": { "properties": { "coach": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballCoach" }, "formation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Formation" }, "startXI": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballPlayer" }, "title": "Startxi", "type": "array" }, "substitutes": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballPlayer" }, "title": "Substitutes", "type": "array" } }, "required": [ "startXI", "substitutes", "coach" ], "title": "SportsFootballLineup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballLineups": { "properties": { "away": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballLineup" }, "home": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballLineup" } }, "required": [ "home", "away" ], "title": "SportsFootballLineups", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsStatistic": { "properties": { "away": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Away" }, "home": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Home" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "SportsStatistic", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureStatusCode": { "enum": [ "AET", "BT", "CANC", "ET", "FT", "1H", "2H", "HT", "LIVE", "NS", "P", "PEN", "PST", "SUSP", "TBD" ], "title": "SportsFootballFixtureStatusCode", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureStatusCode" }, { "type": "null" } ] }, "elapsed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed" }, "extra": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Extra" } }, "title": "SportsFootballFixtureStatus", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentFixture": { "properties": { "aggregate_score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureAggregateScore" }, { "type": "null" } ] }, "events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureEvent" }, "type": "array" }, { "type": "null" } ], "title": "Events" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "lineups": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballLineups" }, { "type": "null" } ] }, "ps_score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "statistics": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsStatistic" }, "type": "array" }, { "type": "null" } ], "title": "Statistics" }, "status": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureStatus" }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "type": { "const": "fixture", "default": "fixture", "enum": [ "fixture" ], "title": "Type", "type": "string" } }, "required": [ "league", "id", "start_time", "teams", "status" ], "title": "SportsFootballContentFixture", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsLabelKind": { "enum": [ "qualification", "relegation", "unknown" ], "title": "SportsLabelKind", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsLabel": { "properties": { "i18n": { "title": "I18N", "type": "string" }, "i18n_opts": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "I18N Opts" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLabelKind" }, { "type": "null" } ] } }, "required": [ "i18n" ], "title": "SportsLabel", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureFootball": { "properties": { "aggregate_score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureAggregateScore" }, { "type": "null" } ] }, "competition_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Competition Id" }, "events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureEvent" }, "type": "array" }, { "type": "null" } ], "title": "Events" }, "group": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLabel" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "ps_score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "round": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Round" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballFixtureStatus" }, { "type": "null" } ] }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo" }, { "type": "null" } ] } }, "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureFootball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStanding": { "properties": { "form": { "title": "Form", "type": "string" }, "goals_against": { "title": "Goals Against", "type": "integer" }, "goals_for": { "title": "Goals For", "type": "integer" }, "label": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLabel" }, { "type": "null" } ] }, "matches_drawn": { "title": "Matches Drawn", "type": "integer" }, "matches_lost": { "title": "Matches Lost", "type": "integer" }, "matches_played": { "title": "Matches Played", "type": "integer" }, "matches_won": { "title": "Matches Won", "type": "integer" }, "points": { "title": "Points", "type": "integer" }, "rank": { "title": "Rank", "type": "integer" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "team", "rank", "matches_played", "matches_won", "matches_drawn", "matches_lost", "goals_for", "goals_against", "points", "form" ], "title": "SportsFootballStanding", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStandingsGroup": { "properties": { "group_name": { "title": "Group Name", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStanding" }, "title": "Standings", "type": "array" } }, "required": [ "group_name", "standings" ], "title": "SportsFootballStandingsGroup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentLeagueGames": { "properties": { "date": { "title": "Date", "type": "string" }, "date_kind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "game_times": { "items": { "type": "integer" }, "title": "Game Times", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureFootball" }, "title": "Games", "type": "array" }, "group_standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStandingsGroup" }, "type": "array" }, { "type": "null" } ], "title": "Group Standings" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "structure": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Structure" }, "type": { "const": "league_games", "default": "league_games", "enum": [ "league_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsFootballContentLeagueGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentTeamStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_standings", "default": "team_standings", "enum": [ "team_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "group_standings" ], "title": "SportsFootballContentTeamStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentLeagueStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_standings", "default": "league_standings", "enum": [ "league_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "group_standings" ], "title": "SportsFootballContentLeagueStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentTeamGames": { "properties": { "competitions": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsCompetition" }, "title": "Competitions", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureFootball" }, "title": "Games", "type": "array" }, "group_standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballStandingsGroup" }, "type": "array" }, { "type": "null" } ], "title": "Group Standings" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_games", "default": "team_games", "enum": [ "team_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "games", "competitions" ], "title": "SportsFootballContentTeamGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsResultFootball": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentFixture" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentLeagueGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentTeamStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentLeagueStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFootballContentTeamGames" } ], "title": "Content" }, "sport": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsType", "default": "football" }, "type": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType" }, "view": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsView" } }, "required": [ "type", "view", "content" ], "title": "SportsResultFootball", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Circuit": { "properties": { "id": { "title": "Id", "type": "integer" }, "image": { "title": "Image", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name", "image" ], "title": "F1Circuit", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Location": { "properties": { "city": { "title": "City", "type": "string" }, "country": { "title": "Country", "type": "string" } }, "required": [ "country", "city" ], "title": "F1Location", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Competition": { "properties": { "id": { "title": "Id", "type": "integer" }, "location": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Location" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name", "location" ], "title": "F1Competition", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1FastestLapDriver": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" } }, "title": "F1FastestLapDriver", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1FastestLap": { "properties": { "driver": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1FastestLapDriver" }, { "type": "null" } ] }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time" } }, "title": "F1FastestLap", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Laps": { "properties": { "current": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "title": "F1Laps", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Race": { "properties": { "circuit": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Circuit" }, "competition": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Competition" }, "date": { "title": "Date", "type": "string" }, "distance": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Distance" }, "fastest_lap": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1FastestLap" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "integer" }, "laps": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Laps" }, { "type": "null" } ] }, "season": { "title": "Season", "type": "integer" }, "status": { "title": "Status", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "competition", "circuit", "season", "type", "date", "status" ], "title": "F1Race", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1RaceRef": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "id": { "title": "Id", "type": "integer" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "F1RaceRef", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Calendar": { "properties": { "next_race": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Race" }, { "type": "null" } ] }, "previous_race": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Race" }, { "type": "null" } ] }, "races": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1RaceRef" }, "title": "Races", "type": "array" } }, "title": "F1Calendar", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Driver": { "properties": { "abbr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Abbr" }, "id": { "title": "Id", "type": "integer" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image" }, "name": { "title": "Name", "type": "string" }, "number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number" } }, "required": [ "id", "name" ], "title": "F1Driver", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Team": { "properties": { "id": { "title": "Id", "type": "integer" }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "F1Team", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1Standing": { "properties": { "behind": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Behind" }, "driver": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Driver" }, { "type": "null" } ] }, "gap": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gap" }, "grid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grid" }, "laps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Laps" }, "points": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Points" }, "position": { "title": "Position", "type": "integer" }, "season": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Season" }, "team": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Team" }, { "type": "null" } ] }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time" }, "wins": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wins" } }, "required": [ "position" ], "title": "F1Standing", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1WeekendEvent": { "properties": { "date": { "title": "Date", "type": "string" }, "status": { "title": "Status", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "date", "status" ], "title": "F1WeekendEvent", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_F1RaceDetail": { "properties": { "event": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Race" }, "qualifying": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Qualifying" }, "sprint_event": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Race" }, { "type": "null" } ] }, "sprint_shootout": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Sprint Shootout" }, "sprint_standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Sprint Standings" }, "standings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Standings" }, "weekend_events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1WeekendEvent" }, "type": "array" }, { "type": "null" } ], "title": "Weekend Events" } }, "required": [ "event" ], "title": "F1RaceDetail", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Formula1Result": { "properties": { "calendar": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Calendar" }, { "type": "null" } ] }, "constructors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Constructors" }, "default_view": { "anyOf": [ { "enum": [ "schedule", "drivers", "constructors" ], "type": "string" }, { "type": "null" } ], "title": "Default View" }, "drivers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1Standing" }, "type": "array" }, { "type": "null" } ], "title": "Drivers" }, "live_race": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1RaceDetail" }, { "type": "null" } ] }, "next_race": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1RaceDetail" }, { "type": "null" } ] }, "previous_race": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_F1RaceDetail" }, { "type": "null" } ] } }, "title": "Formula1Result", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyScoreTable": { "properties": { "ot": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "p1": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "p2": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "p3": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "so": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] } }, "title": "SportsIceHockeyScoreTable", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyFixtureStatusCode": { "enum": [ "NS", "P1", "P2", "P3", "OT", "PT", "BT", "AW", "POST", "CANC", "INTR", "ABD", "AOT", "AP", "FT" ], "title": "SportsIceHockeyFixtureStatusCode", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyFixtureStatus": { "properties": { "code": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyFixtureStatusCode" }, { "type": "null" } ] }, "elapsed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed" } }, "title": "SportsIceHockeyFixtureStatus", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureIceHockey": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Id" }, "league_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "League Id" }, "score": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureScore" }, { "type": "null" } ] }, "score_table": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyScoreTable" }, { "type": "null" } ] }, "start_time": { "title": "Start Time", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyFixtureStatus" }, { "type": "null" } ] }, "teams": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureTeams" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureVideo" }, { "type": "null" } ] } }, "required": [ "id", "teams", "start_time" ], "title": "SportsFixtureIceHockey", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentLeagueGames": { "properties": { "date": { "title": "Date", "type": "string" }, "date_kind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDateKind" }, "game_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Time" }, "game_times": { "items": { "type": "integer" }, "title": "Game Times", "type": "array" }, "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureIceHockey" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_games", "default": "league_games", "enum": [ "league_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "game_times", "date", "date_kind", "games" ], "title": "SportsIceHockeyContentLeagueGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyStanding": { "properties": { "form": { "title": "Form", "type": "string" }, "matches_lost": { "title": "Matches Lost", "type": "integer" }, "matches_lost_pros": { "title": "Matches Lost Pros", "type": "string" }, "matches_played": { "title": "Matches Played", "type": "integer" }, "matches_won": { "title": "Matches Won", "type": "integer" }, "matches_won_pros": { "title": "Matches Won Pros", "type": "string" }, "points": { "title": "Points", "type": "integer" }, "rank": { "title": "Rank", "type": "integer" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" } }, "required": [ "team", "rank", "matches_played", "matches_won", "matches_won_pros", "matches_lost", "matches_lost_pros", "points", "form" ], "title": "SportsIceHockeyStanding", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyStandingsGroup": { "properties": { "group_name": { "title": "Group Name", "type": "string" }, "stage": { "title": "Stage", "type": "string" }, "standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyStanding" }, "title": "Standings", "type": "array" } }, "required": [ "group_name", "standings", "stage" ], "title": "SportsIceHockeyStandingsGroup", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentLeagueStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "type": { "const": "league_standings", "default": "league_standings", "enum": [ "league_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "group_standings" ], "title": "SportsIceHockeyContentLeagueStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentTeamGames": { "properties": { "games": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsFixtureIceHockey" }, "title": "Games", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_games", "default": "team_games", "enum": [ "team_games" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "games" ], "title": "SportsIceHockeyContentTeamGames", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentTeamStandings": { "properties": { "group_standings": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyStandingsGroup" }, "title": "Group Standings", "type": "array" }, "league": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsLeague" }, "team": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsTeam" }, "type": { "const": "team_standings", "default": "team_standings", "enum": [ "team_standings" ], "title": "Type", "type": "string" } }, "required": [ "league", "team", "group_standings" ], "title": "SportsIceHockeyContentTeamStandings", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_SportsResultIceHockey": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentLeagueGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentLeagueStandings" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentTeamGames" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsIceHockeyContentTeamStandings" } ], "title": "Content" }, "sport": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsType", "default": "ice_hockey" }, "type": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsDataType" }, "view": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsView" } }, "required": [ "type", "view", "content" ], "title": "SportsResultIceHockey", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__mixer__specs__atomic__MetaUrl": { "properties": { "favicon": { "title": "Favicon", "type": "string" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostname" }, "netloc": { "title": "Netloc", "type": "string" }, "path": { "title": "Path", "type": "string" }, "scheme": { "title": "Scheme", "type": "string" } }, "required": [ "scheme", "netloc", "favicon", "path" ], "title": "MetaUrl", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TopStoryNewsArticle": { "properties": { "bo_debug": { "default": {}, "title": "Bo Debug", "type": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "extra_snippets": { "default": [], "items": { "type": "string" }, "title": "Extra Snippets", "type": "array" }, "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img" }, "img_small": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img Small" }, "is_live": { "default": false, "title": "Is Live", "type": "boolean" }, "meta_url": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__mixer__specs__atomic__MetaUrl" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age" }, "publish_time": { "title": "Publish Time", "type": "integer" }, "publisher_name": { "title": "Publisher Name", "type": "string" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "title", "url", "meta_url", "publisher_name", "publish_time" ], "title": "TopStoryNewsArticle", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Topic": { "properties": { "index": { "title": "Index", "type": "integer" }, "query": { "title": "Query", "type": "string" }, "score": { "title": "Score", "type": "number" }, "title": { "title": "Title", "type": "string" } }, "required": [ "index", "title", "score", "query" ], "title": "Topic", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TopStoriesNewsResult": { "properties": { "articles": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TopStoryNewsArticle" }, "title": "Articles", "type": "array" }, "is_topical": { "title": "Is Topical", "type": "boolean" }, "topic_id": { "title": "Topic Id", "type": "integer" }, "topics": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Topic" }, "title": "Topics", "type": "array" } }, "required": [ "is_topical", "topic_id" ], "title": "TopStoriesNewsResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Courier": { "properties": { "code": { "title": "Code", "type": "string" }, "domain": { "title": "Domain", "type": "string" }, "name": { "title": "Name", "type": "string" }, "service": { "title": "Service", "type": "string" } }, "required": [ "name", "service", "code", "domain" ], "title": "Courier", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TrackingNumber": { "properties": { "courier": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Courier" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tracking_number": { "title": "Tracking Number", "type": "string" }, "tracking_url": { "title": "Tracking Url", "type": "string" } }, "required": [ "tracking_number", "tracking_url", "courier" ], "title": "TrackingNumber", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_PackageTrackerResult": { "properties": { "matched": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TrackingNumber" }, "title": "Matched", "type": "array" } }, "title": "PackageTrackerResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__mixer__specs__items__DataProvider": { "properties": { "img": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Img" }, "long_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Name" }, "name": { "title": "Name", "type": "string" }, "type": { "default": "external", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "name", "url" ], "title": "DataProvider", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_FinancialInstrumentCategory": { "enum": [ "stock", "index", "fund", "etf", "bond", "other" ], "title": "FinancialInstrumentCategory", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_AssetInfo": { "properties": { "category": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_FinancialInstrumentCategory" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "currency": { "title": "Currency", "type": "string" }, "exchange": { "title": "Exchange", "type": "string" }, "mic_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mic Code" }, "name": { "title": "Name", "type": "string" }, "score": { "default": -1, "title": "Score", "type": "number" }, "symbol": { "title": "Symbol", "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, "required": [ "symbol", "name", "category", "currency", "exchange" ], "title": "AssetInfo", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_ExchangeInfo": { "properties": { "close_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Close Time" }, "open_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Open Time" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "title": "ExchangeInfo", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__stocks__v1__Quote": { "properties": { "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent" }, "close": { "title": "Close", "type": "number" }, "company_name": { "title": "Company Name", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High" }, "latest_price": { "title": "Latest Price", "type": "number" }, "latest_update": { "title": "Latest Update", "type": "integer" }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low" }, "market_cap": { "title": "Market Cap", "type": "integer" }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open" }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe Ratio" }, "primary_exchange": { "title": "Primary Exchange", "type": "string" }, "symbol": { "title": "Symbol", "type": "string" }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume" }, "week_52_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Week 52 High" }, "week_52_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Week 52 Low" } }, "required": [ "symbol", "company_name", "primary_exchange", "market_cap", "latest_price", "close", "latest_update", "currency" ], "title": "Quote", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_StockObservation": { "properties": { "average": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average" }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close" }, "date": { "title": "Date", "type": "string" }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High" }, "label": { "title": "Label", "type": "string" }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low" }, "minute": { "title": "Minute", "type": "string" }, "previous_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Previous Close" }, "timestamp": { "title": "Timestamp", "type": "integer" }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume" } }, "required": [ "date", "minute", "label", "timestamp" ], "title": "StockObservation", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_StockResultTimeseries": { "properties": { "time_range": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TickerPlotTimeRange" }, "timeseries": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_StockObservation" }, "title": "Timeseries", "type": "array" } }, "required": [ "time_range", "timeseries" ], "title": "StockResultTimeseries", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_StockResult": { "properties": { "asset_info": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_AssetInfo" }, "exchange_info": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_ExchangeInfo" }, { "type": "null" } ] }, "quote": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__stocks__v1__Quote" }, "time_range": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TickerPlotTimeRange" }, "timeseries": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_StockResultTimeseries" } }, "required": [ "asset_info", "time_range", "quote", "timeseries" ], "title": "StockResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_UnitConversionDimensionality": { "enum": [ "angle", "area", "data_transfer", "digital", "duration", "energy", "force", "frequency", "length", "mass", "power", "pressure", "speed", "temperature", "volume" ], "title": "UnitConversionDimensionality", "type": "string" }, "brave_search_79e935d283f3__Response762Cca4421D2_UnitConversionResult": { "properties": { "amount": { "title": "Amount", "type": "number" }, "dimensionality": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_UnitConversionDimensionality" }, "from_unit": { "title": "From Unit", "type": "string" }, "to_unit": { "title": "To Unit", "type": "string" } }, "required": [ "amount", "from_unit", "to_unit", "dimensionality" ], "title": "UnitConversionResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TsToDate": { "properties": { "input_ts": { "title": "Input Ts", "type": "integer" }, "intent_type": { "const": "ts_to_date", "default": "ts_to_date", "enum": [ "ts_to_date" ], "title": "Intent Type", "type": "string" } }, "required": [ "input_ts" ], "title": "TsToDate", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_DateToTs": { "properties": { "input_date": { "title": "Input Date", "type": "string" }, "intent_type": { "const": "date_to_ts", "default": "date_to_ts", "enum": [ "date_to_ts" ], "title": "Intent Type", "type": "string" } }, "required": [ "input_date" ], "title": "DateToTs", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_NowToTs": { "properties": { "intent_type": { "const": "now_to_ts", "default": "now_to_ts", "enum": [ "now_to_ts" ], "title": "Intent Type", "type": "string" } }, "title": "NowToTs", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_NowToDate": { "properties": { "intent_type": { "const": "now_to_date", "default": "now_to_date", "enum": [ "now_to_date" ], "title": "Intent Type", "type": "string" } }, "title": "NowToDate", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_UnixTimestampResult": { "properties": { "conversion": { "discriminator": { "mapping": { "date_to_ts": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_DateToTs", "now_to_date": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_NowToDate", "now_to_ts": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_NowToTs", "ts_to_date": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TsToDate" }, "propertyName": "intent_type" }, "oneOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TsToDate" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_DateToTs" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_NowToTs" }, { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_NowToDate" } ], "title": "Conversion" } }, "required": [ "conversion" ], "title": "UnixTimestampResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_WeatherAlert": { "properties": { "description": { "title": "Description", "type": "string" }, "event": { "title": "Event", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "start_relative_i18n": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Relative I18N" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "ts_end": { "title": "Ts End", "type": "integer" }, "ts_start": { "title": "Ts Start", "type": "integer" } }, "required": [ "sender", "event", "ts_start", "ts_end", "description", "tags" ], "title": "WeatherAlert", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_WeatherSnapshot": { "properties": { "description": { "title": "Description", "type": "string" }, "icon": { "title": "Icon", "type": "string" }, "id": { "title": "Id", "type": "integer" }, "main": { "title": "Main", "type": "string" } }, "required": [ "id", "main", "description", "icon" ], "title": "WeatherSnapshot", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_WindSnapshot": { "properties": { "deg": { "title": "Deg", "type": "integer" }, "gust": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gust" }, "speed": { "title": "Speed", "type": "number" } }, "required": [ "speed", "deg" ], "title": "WindSnapshot", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_CurrentWeather": { "properties": { "clouds": { "title": "Clouds", "type": "integer" }, "dew_point": { "title": "Dew Point", "type": "number" }, "feels_like": { "title": "Feels Like", "type": "number" }, "humidity": { "title": "Humidity", "type": "integer" }, "pressure": { "title": "Pressure", "type": "integer" }, "rain": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rain" }, "snow": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snow" }, "sunrise": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunrise" }, "sunset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunset" }, "temp": { "title": "Temp", "type": "number" }, "ts": { "title": "Ts", "type": "integer" }, "uvi": { "title": "Uvi", "type": "number" }, "visibility": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Visibility" }, "weather": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherSnapshot" }, "wind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WindSnapshot" } }, "required": [ "ts", "temp", "feels_like", "pressure", "humidity", "dew_point", "uvi", "clouds", "visibility", "wind", "weather" ], "title": "CurrentWeather", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TemperatureDailyFeelsLikeSummary": { "properties": { "day": { "title": "Day", "type": "number" }, "evening": { "title": "Evening", "type": "number" }, "morning": { "title": "Morning", "type": "number" }, "night": { "title": "Night", "type": "number" } }, "required": [ "day", "night", "evening", "morning" ], "title": "TemperatureDailyFeelsLikeSummary", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TemperatureDailySummary": { "properties": { "day": { "title": "Day", "type": "number" }, "evening": { "title": "Evening", "type": "number" }, "max": { "title": "Max", "type": "number" }, "min": { "title": "Min", "type": "number" }, "morning": { "title": "Morning", "type": "number" }, "night": { "title": "Night", "type": "number" } }, "required": [ "day", "min", "max", "night", "evening", "morning" ], "title": "TemperatureDailySummary", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_WeatherSummaryDay": { "properties": { "clouds": { "title": "Clouds", "type": "integer" }, "date_i18n": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date I18N" }, "dew_point": { "title": "Dew Point", "type": "number" }, "feels_like": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TemperatureDailyFeelsLikeSummary" }, "humidity": { "title": "Humidity", "type": "integer" }, "moonrise": { "title": "Moonrise", "type": "integer" }, "moonset": { "title": "Moonset", "type": "integer" }, "pop": { "title": "Pop", "type": "number" }, "pressure": { "title": "Pressure", "type": "integer" }, "rain": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rain" }, "sunrise": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunrise" }, "sunset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sunset" }, "temperature": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TemperatureDailySummary" }, "ts": { "title": "Ts", "type": "integer" }, "uvi": { "title": "Uvi", "type": "number" }, "weather": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherSnapshot" }, "wind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WindSnapshot" } }, "required": [ "ts", "moonrise", "moonset", "temperature", "feels_like", "pressure", "humidity", "dew_point", "wind", "clouds", "pop", "uvi", "weather" ], "title": "WeatherSummaryDay", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_TemperatureSummary3Hours": { "properties": { "feels_like": { "title": "Feels Like", "type": "number" }, "max": { "title": "Max", "type": "number" }, "min": { "title": "Min", "type": "number" }, "temp": { "title": "Temp", "type": "number" } }, "required": [ "temp", "feels_like", "min", "max" ], "title": "TemperatureSummary3Hours", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_WeatherSummary3Hours": { "properties": { "clouds": { "description": "Cloudiness, %", "title": "Clouds", "type": "integer" }, "humidity": { "description": "Humidity, %", "title": "Humidity", "type": "integer" }, "pop": { "description": "Probability of precipitation", "title": "Pop", "type": "number" }, "pressure": { "description": "Atmospheric pressure, hPa", "title": "Pressure", "type": "integer" }, "rain": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Rain volume in millimeters.", "title": "Rain" }, "snow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Snow volume in millimeters.", "title": "Snow" }, "temperature": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TemperatureSummary3Hours" }, "ts": { "title": "Ts", "type": "integer" }, "visibility": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Average visibility, metres. The maximum value of the visibility is 10 km", "title": "Visibility" }, "weather": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherSnapshot", "description": "Weather conditions information" }, "wind": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WindSnapshot", "description": "Wind information" } }, "required": [ "ts", "temperature", "pressure", "weather", "wind", "humidity", "clouds", "pop" ], "title": "WeatherSummary3Hours", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_Coordinates": { "properties": { "lat": { "title": "Lat", "type": "number" }, "lon": { "title": "Lon", "type": "number" } }, "required": [ "lat", "lon" ], "title": "Coordinates", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__weather__v1__Location": { "properties": { "coords": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Coordinates" }, "country": { "title": "Country", "type": "string" }, "id": { "title": "Id", "type": "integer" }, "implicit_location": { "default": false, "title": "Implicit Location", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "population": { "title": "Population", "type": "integer" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "sunrise": { "title": "Sunrise", "type": "integer" }, "sunset": { "title": "Sunset", "type": "integer" }, "tzoffset": { "title": "Tzoffset", "type": "integer" } }, "required": [ "id", "name", "country", "coords", "population", "sunrise", "sunset", "tzoffset" ], "title": "Location", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_WeatherResult": { "properties": { "alerts": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherAlert" }, "title": "Alerts", "type": "array" }, "current_time_iso": { "title": "Current Time Iso", "type": "string" }, "current_weather": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CurrentWeather" }, "daily": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherSummaryDay" }, "title": "Daily", "type": "array" }, "hours3": { "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherSummary3Hours" }, "title": "Hours3", "type": "array" }, "location": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__rich_header__results__weather__v1__Location" } }, "required": [ "location", "current_time_iso", "current_weather", "daily", "hours3" ], "title": "WeatherResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_RichResult": { "properties": { "american_football": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsResultAmericanFootball" }, { "type": "null" } ] }, "baseball": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsResultBaseball" }, { "type": "null" } ] }, "basketball": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsResultBasketball" }, { "type": "null" } ] }, "calculator": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CalculatorResult" }, { "type": "null" } ] }, "cricket": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsResultCricket" }, { "type": "null" } ] }, "cryptocurrency": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CryptocurrencyResult" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_CurrencyResult" }, { "type": "null" } ] }, "definitions": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_DefinitionsResult" }, { "type": "null" } ] }, "football": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsResultFootball" }, { "type": "null" } ] }, "formula1": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_Formula1Result" }, { "type": "null" } ] }, "ice_hockey": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SportsResultIceHockey" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "news": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_TopStoriesNewsResult" }, { "type": "null" } ] }, "packagetracker": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_PackageTrackerResult" }, { "type": "null" } ] }, "provider": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_snakepit__models__mixer__specs__items__DataProvider" }, { "type": "null" } ] }, "stock": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_StockResult" }, { "type": "null" } ] }, "subtype": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_SearchAPIVertical" }, "type": { "const": "rich", "default": "rich", "enum": [ "rich" ], "title": "Type", "type": "string" }, "unitconversion": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_UnitConversionResult" }, { "type": "null" } ] }, "unixtimestamp": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_UnixTimestampResult" }, { "type": "null" } ] }, "weather": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_WeatherResult" }, { "type": "null" } ] } }, "required": [ "subtype" ], "title": "RichResult", "type": "object" }, "brave_search_79e935d283f3__Response762Cca4421D2_RichHeaderResponse": { "properties": { "response_callback_info": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_ResponseCallbackInfo" }, { "type": "null" } ] }, "results": { "default": [], "items": { "$ref": "#/components/schemas/brave_search_79e935d283f3__Response762Cca4421D2_RichResult" }, "title": "Results", "type": "array" }, "type": { "const": "rich", "default": "rich", "enum": [ "rich" ], "title": "Type", "type": "string" } }, "title": "RichHeaderResponse", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_Organization": { "description": "An entity responsible for another entity.", "properties": { "contact_points": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_Article": { "description": "A model representing an article.", "properties": { "author": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_Organization" }, { "type": "null" } ], "description": "The name of the publisher for the article." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the article." } }, "title": "Article", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_Book": { "description": "A model representing a book result.", "properties": { "author": { "description": "The author of the book.", "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_Price" }, { "type": "null" } ], "description": "The price of the book." }, "publisher": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Person" }, { "type": "null" } ], "description": "The publisher of the book." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A rating that is given to the creative work." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail", "description": "A thumbnail associated with the creative work." } }, "required": [ "name", "thumbnail" ], "title": "CreativeWork", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_Image": { "description": "A model describing an image.", "properties": { "properties": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_ImageProperties" }, { "type": "null" } ], "description": "Metadata on the image." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__VideoData": { "description": "A model representing metadata gathered for a video.", "properties": { "author": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__VideoData", "description": "Meta data for the video." } }, "required": [ "title", "url", "video" ], "title": "VideoResult", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_DeepResult": { "description": "Aggregated deep results from news, social, videos and images.", "properties": { "buttons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_ButtonResult" }, "type": "array" }, { "type": "null" } ], "description": "A list of buttoned results associated with the result.", "title": "Buttons" }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Image" }, "type": "array" }, { "type": "null" } ], "description": "Images associated with the result.", "title": "Images" }, "news": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__VideoResult" }, "type": "array" }, { "type": "null" } ], "description": "Videos associated with the result.", "title": "Videos" } }, "title": "DeepResult", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_QA": { "description": "A question/answer result.", "properties": { "answer": { "description": "The answer to the question.", "title": "Answer", "type": "string" }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_QA" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "FAQ", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_OpeningHours": { "description": "Opening hours of a business at a particular location.", "properties": { "current_day": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_DayOpeningHours" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "The opening hours for the whole week.", "title": "Days" } }, "title": "OpeningHours", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_PictureResults": { "description": "A model representing a list of pictures.", "properties": { "results": { "description": "A list of thumbnail results.", "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__MetaUrl", "description": "Aggregated information about the URL." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_TripadvisorReview": { "description": "A model representing a Tripadvisor review.", "properties": { "author": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_Reviews": { "description": "The reviews associated with an entity.", "properties": { "results": { "description": "A list of trip advisor reviews for the entity.", "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_LocationResult": { "description": "A result that is location relevant.", "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_PictureResults" }, { "type": "null" } ], "description": "A bunch of pictures associated with the business." }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The ratings of the business." }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_LocationWebResult" }, "type": "array" }, { "type": "null" } ], "description": "Web results related to this location.", "title": "Results" }, "reviews": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_MovieData": { "description": "Aggregated data for a movie result.", "properties": { "actors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The rating of the music." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the music." } }, "required": [ "name" ], "title": "MusicRecording", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A rating associated with the product." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating", "description": "The ratings associated with the review." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_QAPage": { "description": "Aggregated result from a question answer page.", "properties": { "answer": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s age. For example, 2 days ago.", "title": "Age" }, "article": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Article" }, { "type": "null" } ], "description": "An article found for the web search result page." }, "book": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Book" }, { "type": "null" } ], "description": "Any book information associated with the web search result page." }, "cluster": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_CreativeWork" }, { "type": "null" } ], "description": "Aggregated information on the creative work found on the web search result." }, "data": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_ForumData" }, { "type": "null" } ], "description": "The enriched aggregated data for the relevant forum post." }, "deep_results": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_MovieData" }, { "type": "null" } ], "description": "The movie associated with the web search result." }, "music_recording": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_MusicRecording" }, { "type": "null" } ], "description": "Aggregated information on music recording found on the web search result." }, "organization": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "qa": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_QAPage" }, { "type": "null" } ], "description": "Any question answer information associated with the web search result page." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating found for the web search result page." }, "recipe": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Recipe" }, { "type": "null" } ], "description": "Aggregated information on a recipe found on the web search result page." }, "restaurant": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_LocationResult" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated. Use location instead." }, "review": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_QAInfobox", "entity": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_EntityInfobox", "generic": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_GenericInfobox", "location": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_InfoboxWithLocation", "place": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_InfoboxPlace" }, "propertyName": "subtype" }, "oneOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_GenericInfobox" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_QAInfobox" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_InfoboxPlace" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_InfoboxWithLocation" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_MixedResponse": { "description": "The ranking order of results on a search result page.", "properties": { "main": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_SearchAPIVertical": { "enum": [ "calculator", "cryptocurrency", "currency", "definitions", "formula1", "packagetracker", "sports", "stocks", "unitconversion", "unixtimestamp", "weather" ], "title": "SearchAPIVertical", "type": "string" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_ResponseCallback": { "properties": { "callback_key": { "description": "The unique key for the callback.", "title": "Callback Key", "type": "string" }, "vertical": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_RichHeaderCallback": { "properties": { "hint": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_ResponseCallback" }, { "type": "null" } ] }, "type": { "const": "rich", "default": "rich", "enum": [ "rich" ], "title": "Type", "type": "string" } }, "title": "RichHeaderCallback", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData": { "properties": { "author": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__videos__VideoResult": { "properties": { "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A human-readable representation of the video\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData" }, { "type": "null" } ], "description": "Metadata for the video." } }, "required": [ "url", "title" ], "title": "VideoResult", "type": "object" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s age. For example, 2 days ago.", "title": "Age" }, "article": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Article" }, { "type": "null" } ], "description": "An article found for the web search result page." }, "book": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Book" }, { "type": "null" } ], "description": "Any book information associated with the web search result page." }, "cluster": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_CreativeWork" }, { "type": "null" } ], "description": "Aggregated information on the creative work found on the web search result." }, "deep_results": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_MovieData" }, { "type": "null" } ], "description": "The movie associated with the web search result." }, "music_recording": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_MusicRecording" }, { "type": "null" } ], "description": "Aggregated information on music recording found on the web search result." }, "organization": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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\u2019s 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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "qa": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_QAPage" }, { "type": "null" } ], "description": "Any question answer information associated with the web search result page." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating found for the web search result page." }, "recipe": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Recipe" }, { "type": "null" } ], "description": "Aggregated information on a recipe found on the web search result page." }, "restaurant": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_LocationResult" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated. Use location instead." }, "review": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_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" }, "brave_search_d8ec797afd8b__Response762Cca4421D2_WebSearchApiResponse": { "properties": { "discussions": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Discussions" }, { "type": "null" } ], "description": "Discussions clusters aggregated from forum posts that are relevant to the query." }, "faq": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_GraphInfobox" }, { "type": "null" } ], "description": "Aggregated information on an entity showable as an infobox." }, "locations": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Locations" }, { "type": "null" } ], "description": "Places of interest (POIs) relevant to location sensitive queries." }, "mixed": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_MixedResponse" }, { "type": "null" } ], "description": "Preferred ranked order of search results." }, "news": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_News" }, { "type": "null" } ], "description": "News results relevant to the query." }, "query": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_RichHeaderCallback" }, { "type": "null" } ], "description": "Callback information to retrieve rich results." }, "summarizer": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_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/brave_search_d8ec797afd8b__Response762Cca4421D2_Videos" }, { "type": "null" } ], "description": "Videos results relevant to the query." }, "web": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_d8ec797afd8b__Response762Cca4421D2_Search" }, { "type": "null" } ], "description": "Web results relevant to the query." } }, "title": "WebSearchApiResponse", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_Organization": { "description": "An entity responsible for another entity.", "properties": { "contact_points": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_Article": { "description": "A model representing an article.", "properties": { "author": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_Organization" }, { "type": "null" } ], "description": "The name of the publisher for the article." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the article." } }, "title": "Article", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_Book": { "description": "A model representing a book result.", "properties": { "author": { "description": "The author of the book.", "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_Price" }, { "type": "null" } ], "description": "The price of the book." }, "publisher": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Person" }, { "type": "null" } ], "description": "The publisher of the book." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A rating that is given to the creative work." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail", "description": "A thumbnail associated with the creative work." } }, "required": [ "name", "thumbnail" ], "title": "CreativeWork", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_Image": { "description": "A model describing an image.", "properties": { "properties": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_ImageProperties" }, { "type": "null" } ], "description": "Metadata on the image." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__VideoData": { "description": "A model representing metadata gathered for a video.", "properties": { "author": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__VideoData", "description": "Meta data for the video." } }, "required": [ "title", "url", "video" ], "title": "VideoResult", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_DeepResult": { "description": "Aggregated deep results from news, social, videos and images.", "properties": { "buttons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_ButtonResult" }, "type": "array" }, { "type": "null" } ], "description": "A list of buttoned results associated with the result.", "title": "Buttons" }, "images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Image" }, "type": "array" }, { "type": "null" } ], "description": "Images associated with the result.", "title": "Images" }, "news": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__VideoResult" }, "type": "array" }, { "type": "null" } ], "description": "Videos associated with the result.", "title": "Videos" } }, "title": "DeepResult", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_QA": { "description": "A question/answer result.", "properties": { "answer": { "description": "The answer to the question.", "title": "Answer", "type": "string" }, "meta_url": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_QA" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "FAQ", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_OpeningHours": { "description": "Opening hours of a business at a particular location.", "properties": { "current_day": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_DayOpeningHours" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "description": "The opening hours for the whole week.", "title": "Days" } }, "title": "OpeningHours", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_PictureResults": { "description": "A model representing a list of pictures.", "properties": { "results": { "description": "A list of thumbnail results.", "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__MetaUrl", "description": "Aggregated information about the URL." }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The page\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_TripadvisorReview": { "description": "A model representing a Tripadvisor review.", "properties": { "author": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_Reviews": { "description": "The reviews associated with an entity.", "properties": { "results": { "description": "A list of trip advisor reviews for the entity.", "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_LocationResult": { "description": "A result that is location relevant.", "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_PictureResults" }, { "type": "null" } ], "description": "A bunch of pictures associated with the business." }, "postal_address": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The ratings of the business." }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_LocationWebResult" }, "type": "array" }, { "type": "null" } ], "description": "Web results related to this location.", "title": "Results" }, "reviews": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_MovieData": { "description": "Aggregated data for a movie result.", "properties": { "actors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "The rating of the music." }, "thumbnail": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Thumbnail" }, { "type": "null" } ], "description": "A thumbnail associated with the music." } }, "required": [ "name" ], "title": "MusicRecording", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "A rating associated with the product." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating", "description": "The ratings associated with the review." }, "thumbnail": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_QAPage": { "description": "Aggregated result from a question answer page.", "properties": { "answer": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s age. For example, 2 days ago.", "title": "Age" }, "article": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Article" }, { "type": "null" } ], "description": "An article found for the web search result page." }, "book": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Book" }, { "type": "null" } ], "description": "Any book information associated with the web search result page." }, "cluster": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_CreativeWork" }, { "type": "null" } ], "description": "Aggregated information on the creative work found on the web search result." }, "data": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_ForumData" }, { "type": "null" } ], "description": "The enriched aggregated data for the relevant forum post." }, "deep_results": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_MovieData" }, { "type": "null" } ], "description": "The movie associated with the web search result." }, "music_recording": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_MusicRecording" }, { "type": "null" } ], "description": "Aggregated information on music recording found on the web search result." }, "organization": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "qa": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_QAPage" }, { "type": "null" } ], "description": "Any question answer information associated with the web search result page." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating found for the web search result page." }, "recipe": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Recipe" }, { "type": "null" } ], "description": "Aggregated information on a recipe found on the web search result page." }, "restaurant": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_LocationResult" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated. Use location instead." }, "review": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, "type": "array" }, { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_QAInfobox", "entity": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_EntityInfobox", "generic": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_GenericInfobox", "location": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_InfoboxWithLocation", "place": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_InfoboxPlace" }, "propertyName": "subtype" }, "oneOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_GenericInfobox" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_QAInfobox" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_InfoboxPlace" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_InfoboxWithLocation" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_MixedResponse": { "description": "The ranking order of results on a search result page.", "properties": { "main": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_SearchAPIVertical": { "enum": [ "calculator", "cryptocurrency", "currency", "definitions", "formula1", "packagetracker", "sports", "stocks", "unitconversion", "unixtimestamp", "weather" ], "title": "SearchAPIVertical", "type": "string" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_ResponseCallback": { "properties": { "callback_key": { "description": "The unique key for the callback.", "title": "Callback Key", "type": "string" }, "vertical": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_RichHeaderCallback": { "properties": { "hint": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_ResponseCallback" }, { "type": "null" } ] }, "type": { "const": "rich", "default": "rich", "enum": [ "rich" ], "title": "Type", "type": "string" } }, "title": "RichHeaderCallback", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData": { "properties": { "author": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__videos__VideoResult": { "properties": { "age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A human-readable representation of the video\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__videos__VideoData" }, { "type": "null" } ], "description": "Metadata for the video." } }, "required": [ "url", "title" ], "title": "VideoResult", "type": "object" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s age. For example, 2 days ago.", "title": "Age" }, "article": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Article" }, { "type": "null" } ], "description": "An article found for the web search result page." }, "book": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Book" }, { "type": "null" } ], "description": "Any book information associated with the web search result page." }, "cluster": { "anyOf": [ { "items": { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_CreativeWork" }, { "type": "null" } ], "description": "Aggregated information on the creative work found on the web search result." }, "deep_results": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_MovieData" }, { "type": "null" } ], "description": "The movie associated with the web search result." }, "music_recording": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_MusicRecording" }, { "type": "null" } ], "description": "Aggregated information on music recording found on the web search result." }, "organization": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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\u2019s 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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Product" }, { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Profile" }, { "type": "null" } ], "description": "A profile associated with the web page." }, "qa": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_QAPage" }, { "type": "null" } ], "description": "Any question answer information associated with the web search result page." }, "rating": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_app__models__products__search__v1__shared__Rating" }, { "type": "null" } ], "description": "Rating found for the web search result page." }, "recipe": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Recipe" }, { "type": "null" } ], "description": "Aggregated information on a recipe found on the web search result page." }, "restaurant": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_LocationResult" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated. Use location instead." }, "review": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_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" }, "brave_search_9d511fdc48e6__Response762Cca4421D2_WebSearchApiResponse": { "properties": { "discussions": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Discussions" }, { "type": "null" } ], "description": "Discussions clusters aggregated from forum posts that are relevant to the query." }, "faq": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_GraphInfobox" }, { "type": "null" } ], "description": "Aggregated information on an entity showable as an infobox." }, "locations": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Locations" }, { "type": "null" } ], "description": "Places of interest (POIs) relevant to location sensitive queries." }, "mixed": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_MixedResponse" }, { "type": "null" } ], "description": "Preferred ranked order of search results." }, "news": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_News" }, { "type": "null" } ], "description": "News results relevant to the query." }, "query": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_RichHeaderCallback" }, { "type": "null" } ], "description": "Callback information to retrieve rich results." }, "summarizer": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_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/brave_search_9d511fdc48e6__Response762Cca4421D2_Videos" }, { "type": "null" } ], "description": "Videos results relevant to the query." }, "web": { "anyOf": [ { "$ref": "#/components/schemas/brave_search_9d511fdc48e6__Response762Cca4421D2_Search" }, { "type": "null" } ], "description": "Web results relevant to the query." } }, "title": "WebSearchApiResponse", "type": "object" }, "financial_73a92c5f25db__Response7B6Efb3B471D_CompanyFacts": { "properties": { "cik": { "description": "The Central Index Key (CIK) of the company.", "type": "string" }, "exchange": { "description": "The exchange of the company.", "type": "string" }, "industry": { "description": "The industry of the company.", "type": "string" }, "is_active": { "description": "Whether the company is currently active.", "type": "boolean" }, "location": { "description": "The location of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "sec_filings_url": { "description": "The URL of the company's SEC filings.", "format": "uri", "type": "string" }, "sector": { "description": "The sector of the company.", "type": "string" }, "sic_code": { "description": "The Standard Industrial Classification (SIC) code of the company.", "type": "string" }, "sic_industry": { "description": "The industry of the company based on the SIC code.", "type": "string" }, "sic_sector": { "description": "The sector of the company based on the SIC code.", "type": "string" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" } }, "type": "object" }, "financial_73a92c5f25db__Response7B6Efb3B471D_CompanyFactsResponse": { "properties": { "company_facts": { "$ref": "#/components/schemas/financial_73a92c5f25db__Response7B6Efb3B471D_CompanyFacts" } }, "type": "object" }, "financial_d4afaa4edad4__Response7B6Efb3B471D_CompanyFacts": { "properties": { "cik": { "description": "The Central Index Key (CIK) of the company.", "type": "string" }, "exchange": { "description": "The exchange of the company.", "type": "string" }, "industry": { "description": "The industry of the company.", "type": "string" }, "is_active": { "description": "Whether the company is currently active.", "type": "boolean" }, "location": { "description": "The location of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "sec_filings_url": { "description": "The URL of the company's SEC filings.", "format": "uri", "type": "string" }, "sector": { "description": "The sector of the company.", "type": "string" }, "sic_code": { "description": "The Standard Industrial Classification (SIC) code of the company.", "type": "string" }, "sic_industry": { "description": "The industry of the company based on the SIC code.", "type": "string" }, "sic_sector": { "description": "The sector of the company based on the SIC code.", "type": "string" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" } }, "type": "object" }, "financial_d4afaa4edad4__Response7B6Efb3B471D_CompanyFactsResponse": { "properties": { "company_facts": { "$ref": "#/components/schemas/financial_d4afaa4edad4__Response7B6Efb3B471D_CompanyFacts" } }, "type": "object" }, "financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsTimeDimension": { "properties": { "capital_expenditure": { "type": [ "number", "null" ] }, "capital_expenditure_chg": { "description": "Percentage change in capital expenditure versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "capital_expenditure_yoy_chg": { "description": "Year-over-year change in capital expenditure versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "cash_and_equivalents": { "type": [ "number", "null" ] }, "change_in_cash_and_equivalents": { "type": [ "number", "null" ] }, "earnings_per_share": { "type": [ "number", "null" ] }, "earnings_per_share_chg": { "description": "Percentage change in EPS versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "earnings_per_share_yoy_chg": { "description": "Year-over-year change in EPS versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "free_cash_flow": { "type": [ "number", "null" ] }, "free_cash_flow_chg": { "description": "Percentage change in free cash flow versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "free_cash_flow_yoy_chg": { "description": "Year-over-year change in free cash flow versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "gross_margin": { "description": "Gross margin as a decimal (gross_profit / revenue). Returned only when calculable.", "type": "number" }, "gross_margin_chg_bps": { "description": "Absolute change in gross margin versus the prior period in basis points (e.g. 200.0 = margin expanded 200 bps). Returned only when calculable.", "type": "number" }, "gross_margin_chg_pct": { "description": "Percentage change in gross margin versus the prior period as a decimal. Returned only when calculable.", "type": "number" }, "gross_margin_yoy_chg_bps": { "description": "Year-over-year change in gross margin versus the same fiscal quarter one year prior, in basis points. Quarterly payload only. Returned only when calculable.", "type": "number" }, "gross_margin_yoy_chg_pct": { "description": "Year-over-year percentage change in gross margin versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "gross_profit": { "type": [ "number", "null" ] }, "gross_profit_chg": { "description": "Percentage change in gross profit versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "gross_profit_yoy_chg": { "description": "Year-over-year change in gross profit versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "net_cash_flow_from_financing": { "type": [ "number", "null" ] }, "net_cash_flow_from_financing_chg": { "description": "Percentage change in net cash flow from financing versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "net_cash_flow_from_financing_yoy_chg": { "description": "Year-over-year change in net cash flow from financing versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "net_cash_flow_from_investing": { "type": [ "number", "null" ] }, "net_cash_flow_from_investing_chg": { "description": "Percentage change in net cash flow from investing versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "net_cash_flow_from_investing_yoy_chg": { "description": "Year-over-year change in net cash flow from investing versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "net_cash_flow_from_operations": { "type": [ "number", "null" ] }, "net_cash_flow_from_operations_chg": { "description": "Percentage change in net cash flow from operations versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "net_cash_flow_from_operations_yoy_chg": { "description": "Year-over-year change in net cash flow from operations versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "net_income": { "type": [ "number", "null" ] }, "net_income_chg": { "description": "Percentage change in net income versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "net_income_yoy_chg": { "description": "Year-over-year change in net income versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "net_margin": { "description": "Net margin as a decimal (net_income / revenue). Returned only when calculable.", "type": "number" }, "net_margin_chg_bps": { "description": "Absolute change in net margin versus the prior period in basis points. Returned only when calculable.", "type": "number" }, "net_margin_chg_pct": { "description": "Percentage change in net margin versus the prior period as a decimal. Returned only when calculable.", "type": "number" }, "net_margin_yoy_chg_bps": { "description": "Year-over-year change in net margin versus the same fiscal quarter one year prior, in basis points. Quarterly payload only. Returned only when calculable.", "type": "number" }, "net_margin_yoy_chg_pct": { "description": "Year-over-year percentage change in net margin versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "operating_income": { "type": [ "number", "null" ] }, "operating_income_chg": { "description": "Percentage change in operating income versus the prior period as a decimal. Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "operating_income_yoy_chg": { "description": "Year-over-year change in operating income versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "operating_margin": { "description": "Operating margin as a decimal (operating_income / revenue). Returned only when calculable.", "type": "number" }, "operating_margin_chg_bps": { "description": "Absolute change in operating margin versus the prior period in basis points. Returned only when calculable.", "type": "number" }, "operating_margin_chg_pct": { "description": "Percentage change in operating margin versus the prior period as a decimal. Returned only when calculable.", "type": "number" }, "operating_margin_yoy_chg_bps": { "description": "Year-over-year change in operating margin versus the same fiscal quarter one year prior, in basis points. Quarterly payload only. Returned only when calculable.", "type": "number" }, "operating_margin_yoy_chg_pct": { "description": "Year-over-year percentage change in operating margin versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "revenue": { "type": [ "number", "null" ] }, "revenue_chg": { "description": "Percentage change in revenue versus the prior period as a decimal (e.g. 0.10 = +10%). Sequential in the quarterly payload, year-over-year in the annual payload. Returned only when calculable.", "type": "number" }, "revenue_yoy_chg": { "description": "Year-over-year change in revenue versus the same fiscal quarter one year prior, as a decimal. Quarterly payload only. Returned only when calculable.", "type": "number" }, "shareholders_equity": { "type": [ "number", "null" ] }, "total_assets": { "type": [ "number", "null" ] }, "total_debt": { "type": [ "number", "null" ] }, "total_liabilities": { "type": [ "number", "null" ] }, "weighted_average_shares": { "type": [ "number", "null" ] }, "weighted_average_shares_diluted": { "type": [ "number", "null" ] } }, "type": "object" }, "financial_1d3bf6d10a84__Response7B6Efb3B471D_Signal": { "description": "A curated market-moving insight derived from this filing. Pre-rendered `headline` is suitable for direct display; `details` carries structured fields for filtering and programmatic use. Signals are returned in priority order (most material first); the `type` itself encodes magnitude (e.g. `STRONG_REVENUE_INCREASE` vs `REVENUE_INCREASE`).", "properties": { "details": { "additionalProperties": true, "description": "Structured fields specific to the signal type. Contents vary: guidance signals carry `low`, `high`, `point_estimate`, `prior_value`, `revision_pct`; segment signals carry `best`, `worst`, `spread_pp`; non-GAAP signals carry `gaap_field`, `non_gaap_value`, `gaap_value`, `divergence_pct`; growth signals carry `current`, `yoy_chg`. Null values are omitted. Refer to type-specific examples.", "type": "object" }, "headline": { "description": "Pre-rendered, human-readable summary suitable for direct display.", "type": "string" }, "metric": { "description": "The metric this signal references, when applicable (e.g. `revenue`, `earnings_per_share`, `operating_margin`, or a guidance/KPI metric name).", "type": [ "string", "null" ] }, "period": { "description": "The fiscal period the signal references (e.g. `2026-Q1`, `FY 2026`). Forward guidance signals reference the guided period; financial signals reference the reporting period of this filing.", "type": [ "string", "null" ] }, "type": { "description": "Signal category. MARGIN_EXPANSION/MARGIN_CONTRACTION: any of gross/operating/net margin moved year-over-year by \u2265100bps. GUIDANCE_RAISED/GUIDANCE_LOWERED/GUIDANCE_REAFFIRMED/GUIDANCE_INITIATED: forward-looking guidance change reported in the filing. SEGMENT_OUTPERFORMANCE/SEGMENT_UNDERPERFORMANCE: best- or worst-performing reportable segment by organic revenue growth. NON_GAAP_DIVERGENCE: an adjusted/non-GAAP figure differs materially from its GAAP counterpart on the same period. BACKLOG_SURGE/BACKLOG_DECLINE: backlog or remaining performance obligations moved year-over-year by \u226520%. REVENUE_INCREASE/STRONG_REVENUE_INCREASE and DECLINE variants: tiered year-over-year revenue change (\u226510% / \u226520% magnitude). NET_INCOME_INCREASE/STRONG_NET_INCOME_INCREASE and DECLINE variants: tiered year-over-year net income change (\u226515% / \u226530%). EPS_INCREASE/STRONG_EPS_INCREASE and DECLINE variants: tiered year-over-year EPS change (\u226515% / \u226530%); independent from net income because share buybacks can amplify EPS movement. CAPEX_INCREASE/STRONG_CAPEX_INCREASE and DECLINE variants: tiered year-over-year capital expenditure change in spending magnitude (\u226515% / \u226530%).", "enum": [ "MARGIN_EXPANSION", "MARGIN_CONTRACTION", "GUIDANCE_RAISED", "GUIDANCE_LOWERED", "GUIDANCE_REAFFIRMED", "GUIDANCE_INITIATED", "SEGMENT_OUTPERFORMANCE", "SEGMENT_UNDERPERFORMANCE", "NON_GAAP_DIVERGENCE", "BACKLOG_SURGE", "BACKLOG_DECLINE", "REVENUE_INCREASE", "REVENUE_DECLINE", "STRONG_REVENUE_INCREASE", "STRONG_REVENUE_DECLINE", "NET_INCOME_INCREASE", "NET_INCOME_DECLINE", "STRONG_NET_INCOME_INCREASE", "STRONG_NET_INCOME_DECLINE", "EPS_INCREASE", "EPS_DECLINE", "STRONG_EPS_INCREASE", "STRONG_EPS_DECLINE", "CAPEX_INCREASE", "CAPEX_DECLINE", "STRONG_CAPEX_INCREASE", "STRONG_CAPEX_DECLINE" ], "type": "string" } }, "required": [ "type", "headline" ], "type": "object" }, "financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsRecord": { "properties": { "accession_number": { "description": "SEC accession number identifying the filing.", "type": "string" }, "annual": { "$ref": "#/components/schemas/financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsTimeDimension" }, "currency": { "description": "ISO currency code (e.g. USD).", "type": "string" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`.", "format": "date", "type": "string" }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": "string" }, "filing_window": { "description": "Market session at the moment SEC accepted the filing, evaluated in Eastern Time. PRE_MARKET = weekday 04:00\u201309:30 ET. DURING_MARKET = weekday 09:30\u201316:00 ET. AFTER_HOURS = weekday outside regular trading hours. WEEKEND = Saturday or Sunday. Null when filing_datetime is unavailable.", "enum": [ "PRE_MARKET", "DURING_MARKET", "AFTER_HOURS", "WEEKEND" ], "type": [ "string", "null" ] }, "fiscal_period": { "description": "Fiscal period label (e.g. 2026-Q1 or 2025-FY).", "type": "string" }, "quarterly": { "$ref": "#/components/schemas/financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsTimeDimension" }, "report_period": { "description": "Report period this filing covers.", "format": "date", "type": "string" }, "signals": { "description": "Curated, market-moving insights distilled from this filing. Each item has a pre-rendered `headline`, structured `details`, and an `importance` ranking. Returned only when at least one signal fires for this entry; field is omitted otherwise. Capped at 8 per entry, ordered HIGH \u2192 MEDIUM \u2192 LOW.", "items": { "$ref": "#/components/schemas/financial_1d3bf6d10a84__Response7B6Efb3B471D_Signal" }, "type": "array" }, "source_type": { "description": "The SEC form type backing this filing.", "enum": [ "8-K", "10-Q", "10-K", "20-F" ], "type": "string" }, "ticker": { "description": "The requested ticker symbol.", "type": "string" } }, "required": [ "ticker", "report_period", "source_type", "filing_date", "filing_url", "accession_number" ], "type": "object" }, "financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsResponse": { "properties": { "earnings": { "description": "Flat list of SEC filings for the ticker, sorted by (report_period DESC, filing_date ASC). When `limit=N`, up to N report_periods worth of filings are returned; entry count may exceed N when a recent period has both an 8-K and a 10-Q/10-K.", "items": { "$ref": "#/components/schemas/financial_1d3bf6d10a84__Response7B6Efb3B471D_EarningsRecord" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_e88a4a544406__Response7B6Efb3B471D_Filing": { "properties": { "accession_number": { "description": "The accession number of the filing.", "type": "string" }, "cik": { "description": "The Central Index Key (CIK) of the company.", "type": "integer" }, "filing_date": { "description": "The date the filing was submitted to the SEC.", "format": "date", "type": "string" }, "filing_type": { "description": "The type of the SEC filing (e.g., 10-Q, 8-K).", "type": "string" }, "report_date": { "description": "The date of the report.", "format": "date", "type": "string" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "url": { "description": "The URL of the SEC filing.", "format": "uri", "type": "string" } }, "type": "object" }, "financial_e88a4a544406__Response7B6Efb3B471D_FilingsResponse": { "properties": { "filings": { "items": { "$ref": "#/components/schemas/financial_e88a4a544406__Response7B6Efb3B471D_Filing" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_e8bcab5539e3__Response7B6Efb3B471D_Exhibit": { "properties": { "description": { "description": "The description of the exhibit.", "type": "string" }, "number": { "description": "The exhibit number (e.g., '99.1').", "type": "string" }, "text": { "description": "The raw text content of the exhibit. Only included when 'include_exhibits' parameter is set to true.", "type": "string" }, "url": { "description": "The URL to the exhibit document on the SEC website.", "format": "uri", "type": "string" } }, "type": "object" }, "financial_e8bcab5539e3__Response7B6Efb3B471D_FilingItem": { "properties": { "exhibits": { "description": "An array of exhibits linked to this item. Only present for 8-K filings when exhibits exist.", "items": { "$ref": "#/components/schemas/financial_e8bcab5539e3__Response7B6Efb3B471D_Exhibit" }, "type": "array" }, "name": { "description": "The item name.", "type": "string" }, "number": { "description": "The item number.", "type": "string" }, "text": { "description": "The item text.", "type": "string" } }, "type": "object" }, "financial_e8bcab5539e3__Response7B6Efb3B471D_FilingItemsResponse": { "properties": { "accession_number": { "description": "The accession number of the filing.", "type": "string" }, "cik": { "description": "The Central Index Key (CIK) of the company.", "type": "string" }, "filing_type": { "description": "The type of filing.", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/financial_e8bcab5539e3__Response7B6Efb3B471D_FilingItem" }, "type": "array" }, "quarter": { "description": "The quarter of the filing.", "type": "integer" }, "resource": { "description": "The resource type identifier.", "type": "string" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" }, "year": { "description": "The year of the filing.", "type": "integer" } }, "type": "object" }, "financial_e8bcab5539e3__Response7B6Efb3B471D_FilingItemsAccepted": { "properties": { "accession_number": { "description": "The accession number of the filing being prepared.", "type": "string" }, "estimated_ready_at": { "description": "When the filing is expected to be ready.", "format": "date-time", "type": "string" }, "message": { "description": "Human-readable description of what to do next.", "type": "string" }, "request_id": { "description": "Identifier for this request; useful when contacting support.", "format": "uuid", "type": "string" }, "result_url": { "description": "The URL to poll for the result.", "type": "string" }, "status": { "description": "Always 'processing' on a 202 response.", "enum": [ "processing" ], "type": "string" } }, "type": "object" }, "financial_f7306fceaf62__Response7B6Efb3B471D_FinancialMetricsResponse": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "asset_turnover": { "description": "Revenue divided by average total assets.", "type": "number" }, "book_value_growth": { "description": "Year-over-year growth in book value.", "type": "number" }, "book_value_per_share": { "description": "Shareholders' equity divided by shares outstanding.", "type": "number" }, "cash_ratio": { "description": "Cash and cash equivalents divided by current liabilities.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "current_ratio": { "description": "Current assets divided by current liabilities.", "type": "number" }, "days_sales_outstanding": { "description": "Average accounts receivable divided by revenue over the period.", "type": "number" }, "debt_to_assets": { "description": "Total debt divided by total assets.", "type": "number" }, "debt_to_equity": { "description": "Total debt divided by shareholders' equity.", "type": "number" }, "earnings_growth": { "description": "Year-over-year growth in earnings.", "type": "number" }, "earnings_per_share": { "description": "Net income divided by weighted average shares outstanding.", "type": "number" }, "earnings_per_share_growth": { "description": "Growth in earnings per share over the period.", "type": "number" }, "ebitda_growth": { "description": "Growth in EBITDA over the period.", "type": "number" }, "enterprise_value": { "description": "The total value of the company (market cap + debt - cash).", "type": "number" }, "enterprise_value_to_ebitda_ratio": { "description": "Enterprise value to EBITDA ratio.", "type": "number" }, "enterprise_value_to_revenue_ratio": { "description": "Enterprise value to revenue ratio.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the financial metrics.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "free_cash_flow_growth": { "description": "Growth in free cash flow over the period.", "type": "number" }, "free_cash_flow_per_share": { "description": "Free cash flow divided by shares outstanding.", "type": "number" }, "free_cash_flow_yield": { "description": "Free cash flow yield.", "type": "number" }, "gross_margin": { "description": "Gross profit as a percentage of revenue.", "type": "number" }, "interest_coverage": { "description": "EBIT divided by interest expense.", "type": "number" }, "inventory_turnover": { "description": "Cost of goods sold divided by average inventory.", "type": "number" }, "net_margin": { "description": "Net income as a percentage of revenue.", "type": "number" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" }, "operating_cash_flow_ratio": { "description": "Operating cash flow divided by current liabilities.", "type": "number" }, "operating_cycle": { "description": "Inventory turnover + receivables turnover.", "type": "number" }, "operating_income_growth": { "description": "Growth in operating income over the period.", "type": "number" }, "operating_margin": { "description": "Operating income as a percentage of revenue.", "type": "number" }, "payout_ratio": { "description": "Dividends paid as a percentage of net income.", "type": "number" }, "peg_ratio": { "description": "Price to earnings growth ratio.", "type": "number" }, "period": { "description": "The time period of the financial metrics.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "price_to_book_ratio": { "description": "Price to book ratio.", "type": "number" }, "price_to_earnings_ratio": { "description": "Price to earnings ratio.", "type": "number" }, "price_to_sales_ratio": { "description": "Price to sales ratio.", "type": "number" }, "quick_ratio": { "description": "Quick assets divided by current liabilities.", "type": "number" }, "receivables_turnover": { "description": "Revenue divided by average accounts receivable.", "type": "number" }, "report_period": { "description": "The reporting period of the financial metrics.", "format": "date", "type": "string" }, "return_on_assets": { "description": "Net income as a percentage of total assets.", "type": "number" }, "return_on_equity": { "description": "Net income as a percentage of shareholders' equity.", "type": "number" }, "return_on_invested_capital": { "description": "Net operating profit after taxes as a percentage of invested capital.", "type": "number" }, "revenue_growth": { "description": "Year-over-year growth in revenue.", "type": "number" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" }, "working_capital_turnover": { "description": "Revenue divided by average working capital.", "type": "number" } }, "type": "object" }, "financial_4ac6c35a9985__Response7B6Efb3B471D_FinancialMetricSnapshot": { "properties": { "asset_turnover": { "description": "Revenue divided by average total assets.", "type": [ "number", "null" ] }, "book_value_growth": { "description": "Year-over-year growth in book value.", "type": [ "number", "null" ] }, "book_value_per_share": { "description": "Shareholders' equity divided by shares outstanding.", "type": [ "number", "null" ] }, "cash_ratio": { "description": "Cash and cash equivalents divided by current liabilities.", "type": [ "number", "null" ] }, "currency": { "description": "The currency in which the financial data is reported.", "type": [ "string", "null" ] }, "current_ratio": { "description": "Current assets divided by current liabilities.", "type": [ "number", "null" ] }, "days_sales_outstanding": { "description": "Average accounts receivable divided by revenue over the period.", "type": [ "number", "null" ] }, "debt_to_assets": { "description": "Total debt divided by total assets.", "type": [ "number", "null" ] }, "debt_to_equity": { "description": "Total debt divided by shareholders' equity.", "type": [ "number", "null" ] }, "earnings_growth": { "description": "Year-over-year growth in earnings.", "type": [ "number", "null" ] }, "earnings_per_share": { "description": "Net income divided by weighted average shares outstanding.", "type": [ "number", "null" ] }, "earnings_per_share_growth": { "description": "Growth in earnings per share over the period.", "type": [ "number", "null" ] }, "ebitda_growth": { "description": "Growth in EBITDA over the period.", "type": [ "number", "null" ] }, "enterprise_value": { "description": "The total value of the company (market cap + debt - cash).", "type": [ "number", "null" ] }, "enterprise_value_to_ebitda_ratio": { "description": "Enterprise value to EBITDA ratio.", "type": [ "number", "null" ] }, "enterprise_value_to_revenue_ratio": { "description": "Enterprise value to revenue ratio.", "type": [ "number", "null" ] }, "free_cash_flow_growth": { "description": "Growth in free cash flow over the period.", "type": [ "number", "null" ] }, "free_cash_flow_per_share": { "description": "Free cash flow divided by shares outstanding.", "type": [ "number", "null" ] }, "free_cash_flow_yield": { "description": "Free cash flow yield.", "type": [ "number", "null" ] }, "gross_margin": { "description": "Gross profit as a percentage of revenue.", "type": [ "number", "null" ] }, "interest_coverage": { "description": "EBIT divided by interest expense.", "type": [ "number", "null" ] }, "inventory_turnover": { "description": "Cost of goods sold divided by average inventory.", "type": [ "number", "null" ] }, "market_cap": { "description": "The total market capitalization (stock price \u00d7 shares outstanding).", "type": [ "number", "null" ] }, "net_margin": { "description": "Net income as a percentage of revenue.", "type": [ "number", "null" ] }, "operating_cash_flow_ratio": { "description": "Operating cash flow divided by current liabilities.", "type": [ "number", "null" ] }, "operating_cycle": { "description": "Inventory turnover + receivables turnover.", "type": [ "number", "null" ] }, "operating_income_growth": { "description": "Growth in operating income over the period.", "type": [ "number", "null" ] }, "operating_margin": { "description": "Operating income as a percentage of revenue.", "type": [ "number", "null" ] }, "payout_ratio": { "description": "Dividends paid as a percentage of net income.", "type": [ "number", "null" ] }, "peg_ratio": { "description": "Price to earnings growth ratio.", "type": [ "number", "null" ] }, "price_to_book_ratio": { "description": "Price to book ratio.", "type": [ "number", "null" ] }, "price_to_earnings_ratio": { "description": "Price to earnings ratio.", "type": [ "number", "null" ] }, "price_to_sales_ratio": { "description": "Price to sales ratio.", "type": [ "number", "null" ] }, "quick_ratio": { "description": "Quick assets divided by current liabilities.", "type": [ "number", "null" ] }, "receivables_turnover": { "description": "Revenue divided by average accounts receivable.", "type": [ "number", "null" ] }, "return_on_assets": { "description": "Net income as a percentage of total assets.", "type": [ "number", "null" ] }, "return_on_equity": { "description": "Net income as a percentage of shareholders' equity.", "type": [ "number", "null" ] }, "return_on_invested_capital": { "description": "Net operating profit after taxes as a percentage of invested capital.", "type": [ "number", "null" ] }, "revenue_growth": { "description": "Year-over-year growth in revenue.", "type": [ "number", "null" ] }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" }, "working_capital_turnover": { "description": "Revenue divided by average working capital.", "type": [ "number", "null" ] } }, "type": "object" }, "financial_4ac6c35a9985__Response7B6Efb3B471D_FinancialMetricSnapshotResponse": { "properties": { "snapshot": { "$ref": "#/components/schemas/financial_4ac6c35a9985__Response7B6Efb3B471D_FinancialMetricSnapshot" } }, "type": "object" }, "financial_bbf410fc1397__Response7B6Efb3B471D_BalanceSheet": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "accumulated_other_comprehensive_income": { "description": "The accumulated other comprehensive income of the company.", "type": "number" }, "cash_and_equivalents": { "description": "The cash and equivalents of the company.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "current_assets": { "description": "The current assets of the company.", "type": "number" }, "current_debt": { "description": "The current debt of the company.", "type": "number" }, "current_investments": { "description": "The current investments of the company.", "type": "number" }, "current_liabilities": { "description": "The current liabilities of the company.", "type": "number" }, "deferred_revenue": { "description": "The deferred revenue of the company.", "type": "number" }, "deposit_liabilities": { "description": "The deposit liabilities of the company.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the balance sheet.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "goodwill_and_intangible_assets": { "description": "The goodwill and intangible assets of the company.", "type": "number" }, "inventory": { "description": "The inventory of the company.", "type": "number" }, "investments": { "description": "The investments of the company.", "type": "number" }, "non_current_assets": { "description": "The non-current assets of the company.", "type": "number" }, "non_current_debt": { "description": "The non-current debt of the company.", "type": "number" }, "non_current_investments": { "description": "The non-current investments of the company.", "type": "number" }, "non_current_liabilities": { "description": "The non-current liabilities of the company.", "type": "number" }, "outstanding_shares": { "description": "The outstanding shares of the company.", "type": "number" }, "period": { "description": "The time period of the balance sheet.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "property_plant_and_equipment": { "description": "The property, plant, and equipment of the company.", "type": "number" }, "report_period": { "description": "The reporting period of the balance sheet.", "format": "date", "type": "string" }, "retained_earnings": { "description": "The retained earnings of the company.", "type": "number" }, "shareholders_equity": { "description": "The shareholders' equity of the company.", "type": "number" }, "tax_assets": { "description": "The tax assets of the company.", "type": "number" }, "tax_liabilities": { "description": "The tax liabilities of the company.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "total_assets": { "description": "The total assets of the company.", "type": "number" }, "total_debt": { "description": "The total debt of the company.", "type": "number" }, "total_liabilities": { "description": "The total liabilities of the company.", "type": "number" }, "trade_and_non_trade_payables": { "description": "The trade and non-trade payables of the company.", "type": "number" }, "trade_and_non_trade_receivables": { "description": "The trade and non-trade receivables of the company.", "type": "number" } }, "type": "object" }, "financial_bbf410fc1397__Response7B6Efb3B471D_CashFlowStatement": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "business_acquisitions_and_disposals": { "description": "The business acquisitions and disposals of the company.", "type": "number" }, "capital_expenditure": { "description": "The capital expenditure of the company.", "type": "number" }, "change_in_cash_and_equivalents": { "description": "The change in cash and equivalents of the company.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "depreciation_and_amortization": { "description": "The depreciation and amortization of the company.", "type": "number" }, "dividends_and_other_cash_distributions": { "description": "The dividends and other cash distributions of the company.", "type": "number" }, "effect_of_exchange_rate_changes": { "description": "The effect of exchange rate changes of the company.", "type": "number" }, "ending_cash_balance": { "description": "The ending cash balance of the company.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the cash flow statement.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "free_cash_flow": { "description": "The free cash flow of the company.", "type": "number" }, "investment_acquisitions_and_disposals": { "description": "The investment acquisitions and disposals of the company.", "type": "number" }, "issuance_or_purchase_of_equity_shares": { "description": "The issuance or purchase of equity shares of the company.", "type": "number" }, "issuance_or_repayment_of_debt_securities": { "description": "The issuance or repayment of debt securities of the company.", "type": "number" }, "net_cash_flow_from_financing": { "description": "The net cash flow from financing of the company.", "type": "number" }, "net_cash_flow_from_investing": { "description": "The net cash flow from investing of the company.", "type": "number" }, "net_cash_flow_from_operations": { "description": "The net cash flow from operations of the company.", "type": "number" }, "net_income": { "description": "The net income of the company.", "type": "number" }, "period": { "description": "The time period of the cash flow statement.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "report_period": { "description": "The reporting period of the cash flow statement.", "format": "date", "type": "string" }, "share_based_compensation": { "description": "The share-based compensation of the company.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" } }, "type": "object" }, "financial_bbf410fc1397__Response7B6Efb3B471D_IncomeStatement": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "consolidated_income": { "description": "The consolidated income of the company.", "type": "number" }, "cost_of_revenue": { "description": "The cost of revenue of the company.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "dividends_per_common_share": { "description": "The dividends per common share of the company.", "type": "number" }, "earnings_per_share": { "description": "The earnings per share of the company.", "type": "number" }, "earnings_per_share_diluted": { "description": "The diluted earnings per share of the company.", "type": "number" }, "ebit": { "description": "The earnings before interest and taxes of the company.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the income statement.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "gross_profit": { "description": "The gross profit of the company.", "type": "number" }, "income_tax_expense": { "description": "The income tax expenses of the company.", "type": "number" }, "interest_expense": { "description": "The interest expenses of the company.", "type": "number" }, "net_income": { "description": "The net income of the company.", "type": "number" }, "net_income_common_stock": { "description": "The net income available to common stockholders of the company.", "type": "number" }, "net_income_discontinued_operations": { "description": "The net income from discontinued operations of the company.", "type": "number" }, "net_income_non_controlling_interests": { "description": "The net income from non-controlling interests of the company.", "type": "number" }, "operating_expense": { "description": "The operating expenses of the company.", "type": "number" }, "operating_income": { "description": "The operating income of the company.", "type": "number" }, "period": { "description": "The time period of the income statement.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "preferred_dividends_impact": { "description": "The impact of preferred dividends on the net income of the company.", "type": "number" }, "report_period": { "description": "The reporting period of the income statement.", "format": "date", "type": "string" }, "research_and_development": { "description": "The research and development expenses of the company.", "type": "number" }, "revenue": { "description": "The total revenue of the company.", "type": "number" }, "selling_general_and_administrative_expenses": { "description": "The selling, general, and administrative expenses of the company.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "weighted_average_shares": { "description": "The weighted average shares of the company.", "type": "number" }, "weighted_average_shares_diluted": { "description": "The diluted weighted average shares of the company.", "type": "number" } }, "type": "object" }, "financial_bbf410fc1397__Response7B6Efb3B471D_FinancialsResponse": { "properties": { "financials": { "properties": { "balance_sheets": { "items": { "$ref": "#/components/schemas/financial_bbf410fc1397__Response7B6Efb3B471D_BalanceSheet" }, "type": "array" }, "cash_flow_statements": { "items": { "$ref": "#/components/schemas/financial_bbf410fc1397__Response7B6Efb3B471D_CashFlowStatement" }, "type": "array" }, "income_statements": { "items": { "$ref": "#/components/schemas/financial_bbf410fc1397__Response7B6Efb3B471D_IncomeStatement" }, "type": "array" } }, "type": "object" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_2fb33f4d98b5__Response7B6Efb3B471D_BalanceSheet": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "accumulated_other_comprehensive_income": { "description": "The accumulated other comprehensive income of the company.", "type": "number" }, "cash_and_equivalents": { "description": "The cash and equivalents of the company.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "current_assets": { "description": "The current assets of the company.", "type": "number" }, "current_debt": { "description": "The current debt of the company.", "type": "number" }, "current_investments": { "description": "The current investments of the company.", "type": "number" }, "current_liabilities": { "description": "The current liabilities of the company.", "type": "number" }, "deferred_revenue": { "description": "The deferred revenue of the company.", "type": "number" }, "deposit_liabilities": { "description": "The deposit liabilities of the company.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the balance sheet.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "goodwill_and_intangible_assets": { "description": "The goodwill and intangible assets of the company.", "type": "number" }, "inventory": { "description": "The inventory of the company.", "type": "number" }, "investments": { "description": "The investments of the company.", "type": "number" }, "non_current_assets": { "description": "The non-current assets of the company.", "type": "number" }, "non_current_debt": { "description": "The non-current debt of the company.", "type": "number" }, "non_current_investments": { "description": "The non-current investments of the company.", "type": "number" }, "non_current_liabilities": { "description": "The non-current liabilities of the company.", "type": "number" }, "outstanding_shares": { "description": "The outstanding shares of the company.", "type": "number" }, "period": { "description": "The time period of the balance sheet.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "property_plant_and_equipment": { "description": "The property, plant, and equipment of the company.", "type": "number" }, "report_period": { "description": "The reporting period of the balance sheet.", "format": "date", "type": "string" }, "retained_earnings": { "description": "The retained earnings of the company.", "type": "number" }, "shareholders_equity": { "description": "The shareholders' equity of the company.", "type": "number" }, "tax_assets": { "description": "The tax assets of the company.", "type": "number" }, "tax_liabilities": { "description": "The tax liabilities of the company.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "total_assets": { "description": "The total assets of the company.", "type": "number" }, "total_debt": { "description": "The total debt of the company.", "type": "number" }, "total_liabilities": { "description": "The total liabilities of the company.", "type": "number" }, "trade_and_non_trade_payables": { "description": "The trade and non-trade payables of the company.", "type": "number" }, "trade_and_non_trade_receivables": { "description": "The trade and non-trade receivables of the company.", "type": "number" } }, "type": "object" }, "financial_2fb33f4d98b5__Response7B6Efb3B471D_BalanceSheetResponse": { "properties": { "balance_sheets": { "items": { "$ref": "#/components/schemas/financial_2fb33f4d98b5__Response7B6Efb3B471D_BalanceSheet" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_6bac5d996461__Response7B6Efb3B471D_CashFlowStatement": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "business_acquisitions_and_disposals": { "description": "The business acquisitions and disposals of the company.", "type": "number" }, "capital_expenditure": { "description": "The capital expenditure of the company.", "type": "number" }, "change_in_cash_and_equivalents": { "description": "The change in cash and equivalents of the company.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "depreciation_and_amortization": { "description": "The depreciation and amortization of the company.", "type": "number" }, "dividends_and_other_cash_distributions": { "description": "The dividends and other cash distributions of the company.", "type": "number" }, "effect_of_exchange_rate_changes": { "description": "The effect of exchange rate changes of the company.", "type": "number" }, "ending_cash_balance": { "description": "The ending cash balance of the company.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the cash flow statement.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "free_cash_flow": { "description": "The free cash flow of the company.", "type": "number" }, "investment_acquisitions_and_disposals": { "description": "The investment acquisitions and disposals of the company.", "type": "number" }, "issuance_or_purchase_of_equity_shares": { "description": "The issuance or purchase of equity shares of the company.", "type": "number" }, "issuance_or_repayment_of_debt_securities": { "description": "The issuance or repayment of debt securities of the company.", "type": "number" }, "net_cash_flow_from_financing": { "description": "The net cash flow from financing of the company.", "type": "number" }, "net_cash_flow_from_investing": { "description": "The net cash flow from investing of the company.", "type": "number" }, "net_cash_flow_from_operations": { "description": "The net cash flow from operations of the company.", "type": "number" }, "net_income": { "description": "The net income of the company.", "type": "number" }, "period": { "description": "The time period of the cash flow statement.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "report_period": { "description": "The reporting period of the cash flow statement.", "format": "date", "type": "string" }, "share_based_compensation": { "description": "The share-based compensation of the company.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" } }, "type": "object" }, "financial_6bac5d996461__Response7B6Efb3B471D_CashFlowStatementResponse": { "properties": { "cash_flow_statements": { "items": { "$ref": "#/components/schemas/financial_6bac5d996461__Response7B6Efb3B471D_CashFlowStatement" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_264348f340ef__Response7B6Efb3B471D_IncomeStatement": { "properties": { "accession_number": { "description": "The SEC accession number of the filing.", "type": [ "string", "null" ] }, "consolidated_income": { "description": "The consolidated income of the company.", "type": "number" }, "cost_of_revenue": { "description": "The cost of revenue of the company.", "type": "number" }, "currency": { "description": "The currency in which the financial data is reported.", "type": "string" }, "dividends_per_common_share": { "description": "The dividends per common share of the company.", "type": "number" }, "earnings_per_share": { "description": "The earnings per share of the company.", "type": "number" }, "earnings_per_share_diluted": { "description": "The diluted earnings per share of the company.", "type": "number" }, "ebit": { "description": "The earnings before interest and taxes of the company.", "type": "number" }, "filing_date": { "description": "Calendar day SEC accepted the filing, in Eastern Time (the SEC's operating timezone). Calendar-day pair to `filing_datetime`. Null when no dated SEC filing is linked to the row.", "format": "date", "type": [ "string", "null" ] }, "filing_datetime": { "description": "Sub-day timestamp recording when SEC accepted the filing, in Eastern Time. Sourced from SEC's `acceptanceDateTime` field on the EDGAR submissions API. Pairs with `filing_date` (calendar-day precision of the same event).", "format": "date-time", "type": [ "string", "null" ] }, "filing_url": { "description": "URL to the SEC filing.", "format": "uri", "type": [ "string", "null" ] }, "fiscal_period": { "description": "The fiscal period of the income statement.", "type": "string" }, "form_type": { "description": "The SEC form this row was sourced from (`10-K`, `10-Q/A`, `20-F`, `S-1`, ...). The exact form as filed, so amendments keep their `/A` suffix. Null when `period` is `ttm`: a trailing twelve month window can span multiple filings, so we don't attribute it to one. A `quarterly` row can carry `10-K` when the fourth quarter is derived from the fiscal-year filing.", "type": [ "string", "null" ] }, "gross_profit": { "description": "The gross profit of the company.", "type": "number" }, "income_tax_expense": { "description": "The income tax expenses of the company.", "type": "number" }, "interest_expense": { "description": "The interest expenses of the company.", "type": "number" }, "net_income": { "description": "The net income of the company.", "type": "number" }, "net_income_common_stock": { "description": "The net income available to common stockholders of the company.", "type": "number" }, "net_income_discontinued_operations": { "description": "The net income from discontinued operations of the company.", "type": "number" }, "net_income_non_controlling_interests": { "description": "The net income from non-controlling interests of the company.", "type": "number" }, "operating_expense": { "description": "The operating expenses of the company.", "type": "number" }, "operating_income": { "description": "The operating income of the company.", "type": "number" }, "period": { "description": "The time period of the income statement.", "enum": [ "quarterly", "ttm", "annual" ], "type": "string" }, "preferred_dividends_impact": { "description": "The impact of preferred dividends on the net income of the company.", "type": "number" }, "report_period": { "description": "The reporting period of the income statement.", "format": "date", "type": "string" }, "research_and_development": { "description": "The research and development expenses of the company.", "type": "number" }, "revenue": { "description": "The total revenue of the company.", "type": "number" }, "selling_general_and_administrative_expenses": { "description": "The selling, general, and administrative expenses of the company.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "weighted_average_shares": { "description": "The weighted average shares of the company.", "type": "number" }, "weighted_average_shares_diluted": { "description": "The diluted weighted average shares of the company.", "type": "number" } }, "type": "object" }, "financial_264348f340ef__Response7B6Efb3B471D_IncomeStatementResponse": { "properties": { "income_statements": { "items": { "$ref": "#/components/schemas/financial_264348f340ef__Response7B6Efb3B471D_IncomeStatement" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_c38f482ced2d__Response7B6Efb3B471D_FinancialsSearchResponse": { "properties": { "search_results": { "items": { "additionalProperties": { "description": "Additional financial metrics based on the search criteria.", "type": "string" }, "properties": { "currency": { "description": "The currency of the financial data.", "type": "string" }, "period": { "description": "The time period of the financial data.", "enum": [ "annual", "quarterly", "ttm" ], "type": "string" }, "report_period": { "description": "The reporting period of the financial data.", "format": "date", "type": "string" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "financial_3790ccc3be34__Response7B6Efb3B471D_FinancialsSearchResponse": { "properties": { "search_results": { "items": { "additionalProperties": { "description": "Additional financial metrics based on the search criteria.", "type": "string" }, "properties": { "currency": { "description": "The currency of the financial data.", "type": "string" }, "period": { "description": "The time period of the financial data.", "enum": [ "annual", "quarterly", "ttm" ], "type": "string" }, "report_period": { "description": "The reporting period of the financial data.", "format": "date", "type": "string" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "financial_8fde0fab75ba__Response7B6Efb3B471D_InsiderTrade": { "properties": { "filing_date": { "description": "The date the filing was accepted by the SEC.", "format": "date", "type": "string" }, "form_type": { "description": "The SEC form type: 4 (trade report) or 5 (annual statement), or their amendments 4/A, 5/A.", "type": "string" }, "is_board_director": { "description": "Whether the insider is a board director.", "type": "boolean" }, "issuer": { "description": "The name of the issuing company.", "type": "string" }, "name": { "description": "The name of the insider.", "type": "string" }, "report_period": { "description": "The reporting period declared on the filing. For Form 4 this is the date of the earliest transaction reported, and it may be earlier than the filing_date.", "format": "date", "type": "string" }, "security_title": { "description": "The title of the security involved in the transaction.", "type": "string" }, "shares_owned_after_transaction": { "description": "The number of shares owned after the transaction.", "type": "number" }, "shares_owned_before_transaction": { "description": "The number of shares owned before the transaction.", "type": "number" }, "ticker": { "description": "The ticker symbol of the company.", "type": "string" }, "title": { "description": "The title of the insider.", "type": "string" }, "transaction_code": { "description": "The SEC Form 4 transaction code (for example, `P` for open market purchase, `S` for open market sale, `M` for exercise of derivative securities, `F` for shares withheld to cover taxes, `G` for gift). Distinguishes the individual legs of a multi-part filing.", "type": "string" }, "transaction_date": { "description": "The date of the transaction.", "format": "date", "type": "string" }, "transaction_price_per_share": { "description": "The price per share in the transaction.", "type": "number" }, "transaction_shares": { "description": "The number of shares involved in the transaction.", "type": "number" }, "transaction_type": { "description": "A human-readable description of the transaction, derived from the transaction_code.", "type": "string" }, "transaction_value": { "description": "The total value of the transaction.", "type": "number" } }, "type": "object" }, "financial_8fde0fab75ba__Response7B6Efb3B471D_InsiderTradesResponse": { "properties": { "insider_trades": { "items": { "$ref": "#/components/schemas/financial_8fde0fab75ba__Response7B6Efb3B471D_InsiderTrade" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_74626c880524__Response7B6Efb3B471D_KPIGuidanceItem": { "properties": { "change_direction": { "description": "Direction: raised, lowered, maintained, initiated, withdrawn.", "example": "initiated", "type": [ "string", "null" ] }, "high": { "description": "High end of guidance range.", "example": 8.0, "type": [ "number", "null" ] }, "low": { "description": "Low end of guidance range.", "example": 6.0, "type": [ "number", "null" ] }, "metric_name": { "example": "Operating Margin", "type": "string" }, "period": { "example": "Q2 2026", "type": "string" }, "period_type": { "enum": [ "quarterly", "annual" ], "type": "string" }, "point_estimate": { "description": "Single-point guidance when no range is given.", "type": [ "number", "null" ] }, "prior_value": { "description": "Prior guidance value for revisions.", "type": [ "number", "null" ] }, "raw_text": { "description": "Original guidance text from the filing.", "type": [ "string", "null" ] }, "segment": { "type": [ "string", "null" ] }, "source_text": { "type": [ "string", "null" ] }, "source_url": { "format": "uri", "type": [ "string", "null" ] }, "ticker": { "example": "DAL", "type": "string" }, "unit": { "example": "%", "type": "string" }, "value": { "type": [ "number", "null" ] } }, "required": [ "ticker", "metric_name", "period", "period_type" ], "type": "object" }, "financial_74626c880524__Response7B6Efb3B471D_KPIGuidanceResponse": { "properties": { "kpi_guidance": { "items": { "$ref": "#/components/schemas/financial_74626c880524__Response7B6Efb3B471D_KPIGuidanceItem" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_d8a477b1ae21__Response7B6Efb3B471D_KPIMetric": { "properties": { "metric_name": { "description": "Canonical metric name.", "example": "load_factor", "type": "string" }, "period": { "description": "Reporting period (e.g., Q4 2025, FY 2025, or a date like 2025-04-30 for non-standard fiscal years).", "example": "Q4 2025", "type": "string" }, "period_type": { "description": "Whether this is a quarterly or annual figure.", "enum": [ "quarterly", "annual" ], "example": "quarterly", "type": "string" }, "segment": { "description": "Business segment, geography, or sub-category. Only present when the metric is reported for a sub-unit rather than the consolidated entity.", "example": "Commercial Engines & Services", "type": [ "string", "null" ] }, "source_text": { "description": "The source text span from the filing where this value was found.", "example": "Passenger load factor", "type": [ "string", "null" ] }, "source_url": { "description": "Direct link to the SEC filing. When available, includes a text fragment that highlights the source in the browser.", "example": "https://www.sec.gov/Archives/edgar/data/27904/000002790426000008/deltaairlinesannouncesdece.htm", "format": "uri", "type": "string" }, "ticker": { "description": "Stock ticker symbol.", "example": "DAL", "type": "string" }, "unit": { "description": "Unit of measure (e.g., %, cents, dollars, miles, count).", "example": "%", "type": "string" }, "value": { "description": "Extracted numeric value.", "example": 82.0, "type": [ "number", "null" ] }, "yoy_change_pct": { "description": "Year-over-year percentage change.", "example": -2.381, "type": [ "number", "null" ] }, "yoy_value": { "description": "Year-over-year comparison value from the prior period.", "example": 84.0, "type": [ "number", "null" ] } }, "required": [ "ticker", "metric_name", "value", "unit", "period", "period_type" ], "type": "object" }, "financial_d8a477b1ae21__Response7B6Efb3B471D_KPIMetricsResponse": { "properties": { "kpi_metrics": { "items": { "$ref": "#/components/schemas/financial_d8a477b1ae21__Response7B6Efb3B471D_KPIMetric" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_da1d41c0cf88__Response7B6Efb3B471D_KPINonGAAPMetric": { "properties": { "gaap_equivalent": { "description": "The GAAP line item this metric adjusts.", "example": "Diluted earnings per share", "type": [ "string", "null" ] }, "key_adjustments": { "description": "Description of adjustments made.", "example": "Excludes restructuring charges of $150M", "type": [ "string", "null" ] }, "metric_name": { "example": "Adjusted Diluted EPS", "type": "string" }, "period": { "example": "Q1 2026", "type": "string" }, "period_type": { "enum": [ "quarterly", "annual" ], "type": "string" }, "source_text": { "type": [ "string", "null" ] }, "source_url": { "format": "uri", "type": [ "string", "null" ] }, "ticker": { "example": "DAL", "type": "string" }, "unit": { "example": "USD per share", "type": "string" }, "value": { "example": 0.64, "type": [ "number", "null" ] } }, "required": [ "ticker", "metric_name", "value", "unit", "period", "period_type" ], "type": "object" }, "financial_da1d41c0cf88__Response7B6Efb3B471D_KPINonGAAPResponse": { "properties": { "kpi_non_gaap": { "items": { "$ref": "#/components/schemas/financial_da1d41c0cf88__Response7B6Efb3B471D_KPINonGAAPMetric" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_37506d2d17c9__Response7B6Efb3B471D_InterestRate": { "properties": { "bank": { "description": "The symbol of the central bank.", "type": "string" }, "date": { "description": "The calendar day the rate is in effect, in YYYY-MM-DD format.", "type": "string" }, "name": { "description": "The name of the central bank.", "type": "string" }, "rate": { "description": "The policy rate in percent on that day. For the Federal Reserve, the midpoint of the target range.", "type": "number" } }, "type": "object" }, "financial_37506d2d17c9__Response7B6Efb3B471D_InterestRatesResponse": { "properties": { "interest_rates": { "items": { "$ref": "#/components/schemas/financial_37506d2d17c9__Response7B6Efb3B471D_InterestRate" }, "type": "array" }, "next_page_url": { "description": "History only. Absolute URL of the next page of results. Present only when more rows remain; request it as-is to continue. Each page holds up to 10 rows.", "type": "string" } }, "type": "object" }, "financial_6ef62a0c5a7d__Response7B6Efb3B471D_InterestRate": { "properties": { "bank": { "description": "The symbol of the central bank.", "type": "string" }, "date": { "description": "The calendar day the rate is in effect, in YYYY-MM-DD format.", "type": "string" }, "name": { "description": "The name of the central bank.", "type": "string" }, "rate": { "description": "The policy rate in percent on that day. For the Federal Reserve, the midpoint of the target range.", "type": "number" } }, "type": "object" }, "financial_6ef62a0c5a7d__Response7B6Efb3B471D_InterestRatesResponse": { "properties": { "interest_rates": { "items": { "$ref": "#/components/schemas/financial_6ef62a0c5a7d__Response7B6Efb3B471D_InterestRate" }, "type": "array" }, "next_page_url": { "description": "History only. Absolute URL of the next page of results. Present only when more rows remain; request it as-is to continue. Each page holds up to 10 rows.", "type": "string" } }, "type": "object" }, "financial_2c987cdacfbb__Response7B6Efb3B471D_News": { "properties": { "date": { "description": "The date the news article was published.", "format": "date", "type": "string" }, "source": { "description": "The source of the news article.", "type": "string" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "title": { "description": "The title of the news article.", "type": "string" }, "url": { "description": "The URL of the news article.", "format": "uri", "type": "string" } }, "type": "object" }, "financial_2c987cdacfbb__Response7B6Efb3B471D_NewsResponse": { "properties": { "news": { "items": { "$ref": "#/components/schemas/financial_2c987cdacfbb__Response7B6Efb3B471D_News" }, "type": "array" }, "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 10 records.", "type": "string" } }, "type": "object" }, "financial_3d46c2d9901e__Response7B6Efb3B471D_Price": { "properties": { "close": { "description": "The close price of the ticker in the given time period.", "type": "number" }, "high": { "description": "The high price of the ticker in the given time period.", "type": "number" }, "low": { "description": "The low price of the ticker in the given time period.", "type": "number" }, "open": { "description": "The open price of the ticker in the given time period.", "type": "number" }, "time": { "description": "The human-readable time format of the price in UTC.", "type": "string" }, "volume": { "description": "The trading volume of the ticker in the given time period.", "type": [ "integer", "null" ] } }, "type": "object" }, "financial_3d46c2d9901e__Response7B6Efb3B471D_PricesResponse": { "properties": { "next_page_url": { "description": "Absolute URL of the next page of results. Present only when more results remain; request it as-is to continue. Each page holds up to 100 records.", "type": "string" }, "prices": { "items": { "$ref": "#/components/schemas/financial_3d46c2d9901e__Response7B6Efb3B471D_Price" }, "type": "array" }, "ticker": { "description": "The ticker symbol.", "type": "string" } }, "type": "object" }, "financial_c14b4093f514__Response7B6Efb3B471D_PriceSnapshot": { "properties": { "day_change": { "description": "The price change since the previous trading day's close.", "type": "number" }, "day_change_percent": { "description": "The percentage price change since the previous trading day's close.", "type": "number" }, "price": { "description": "The current price of the stock.", "type": "number" }, "ticker": { "description": "The ticker symbol.", "type": "string" }, "time": { "description": "The timestamp of the price snapshot in human-readable format in UTC.", "type": "string" }, "time_milliseconds": { "description": "The timestamp of the price snapshot in milliseconds since epoch.", "type": "number" } }, "type": "object" }, "financial_c14b4093f514__Response7B6Efb3B471D_PriceSnapshotResponse": { "properties": { "snapshot": { "$ref": "#/components/schemas/financial_c14b4093f514__Response7B6Efb3B471D_PriceSnapshot" } }, "type": "object" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_ExchangeIndex": { "description": "Identifier for an exchange shard.", "example": 0, "type": "integer" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars": { "description": "Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., \"0.56\", \"0.5600\"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.", "example": "0.5600", "type": "string" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_MveSelectedLeg": { "properties": { "event_ticker": { "description": "Unique identifier for the selected event", "type": "string", "x-go-type-skip-optional-pointer": true }, "market_ticker": { "description": "Unique identifier for the selected market", "type": "string", "x-go-type-skip-optional-pointer": true }, "side": { "description": "The side of the selected market", "type": "string", "x-go-type-skip-optional-pointer": true }, "yes_settlement_value_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" } }, "type": "object" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointCount": { "description": "Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0-2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts.", "example": "10.00", "type": "string" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_PriceRange": { "properties": { "end": { "description": "Ending price for this range in dollars", "type": "string" }, "start": { "description": "Starting price for this range in dollars", "type": "string" }, "step": { "description": "Price step/tick size for this range in dollars", "type": "string" } }, "required": [ "start", "end", "step" ], "type": "object" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_Market": { "properties": { "can_close_early": { "type": "boolean" }, "cap_strike": { "description": "Maximum expiration value that leads to a YES settlement", "format": "double", "type": [ "number", "null" ], "x-omitempty": true }, "close_time": { "format": "date-time", "type": "string" }, "created_time": { "format": "date-time", "type": "string" }, "custom_strike": { "description": "Expiration value for each target that leads to a YES settlement", "type": [ "object", "null" ], "x-omitempty": true }, "early_close_condition": { "description": "The condition under which the market can close early", "type": [ "string", "null" ], "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "event_ticker": { "type": "string" }, "exchange_index": { "allOf": [ { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_ExchangeIndex" } ], "x-go-type-skip-optional-pointer": true, "x-omitempty": false }, "expected_expiration_time": { "description": "Time when this market is expected to expire", "format": "date-time", "type": [ "string", "null" ], "x-omitempty": true }, "expiration_time": { "deprecated": true, "format": "date-time", "type": "string", "x-go-type-skip-optional-pointer": true }, "expiration_value": { "description": "The value that was considered for the settlement", "type": "string" }, "fee_waiver_expiration_time": { "description": "Time when this market's fee waiver expires", "format": "date-time", "type": [ "string", "null" ], "x-omitempty": true }, "floor_strike": { "description": "Minimum expiration value that leads to a YES settlement", "format": "double", "type": [ "number", "null" ], "x-omitempty": true }, "functional_strike": { "description": "Mapping from expiration values to settlement values", "type": [ "string", "null" ], "x-omitempty": true }, "is_provisional": { "description": "If true, the market may be removed after determination if there is no activity on it", "type": "boolean", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "last_price_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "latest_expiration_time": { "description": "Latest possible time for this market to expire", "format": "date-time", "type": "string" }, "market_type": { "description": "Identifies the type of market", "enum": [ "binary", "scalar" ], "type": "string" }, "mve_collection_ticker": { "description": "The ticker of the multivariate event collection", "type": "string", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "mve_selected_legs": { "items": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_MveSelectedLeg" }, "type": "array", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "no_ask_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "no_bid_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "no_sub_title": { "description": "Shortened title for the no side of this market", "type": "string" }, "notional_value_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "occurrence_datetime": { "description": "The recorded datetime when the underlying event occurred, if available", "format": "date-time", "type": [ "string", "null" ] }, "open_interest_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointCount" }, "open_time": { "format": "date-time", "type": "string" }, "previous_price_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "previous_yes_ask_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "previous_yes_bid_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "price_level_structure": { "description": "Price level structure for this market, defining price ranges and tick sizes", "type": "string" }, "price_ranges": { "description": "Valid price ranges for orders on this market", "items": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_PriceRange" }, "type": "array" }, "primary_participant_key": { "type": [ "string", "null" ], "x-omitempty": true }, "result": { "enum": [ "yes", "no", "scalar", "" ], "type": "string" }, "rules_primary": { "description": "A plain language description of the most important market terms", "type": "string" }, "rules_secondary": { "description": "A plain language description of secondary market terms", "type": "string" }, "settlement_bounds_type": { "description": "Which settlement bounds apply to this market. default means the market has no settlement bounds", "enum": [ "default", "floor" ], "type": "string" }, "settlement_floor_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "settlement_timer_seconds": { "description": "The amount of time after determination that the market settles", "type": "integer" }, "settlement_ts": { "description": "Timestamp when the market was settled. Only filled for settled markets", "format": "date-time", "type": [ "string", "null" ], "x-omitempty": true }, "settlement_value_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "status": { "description": "The current status of the market in its lifecycle.", "enum": [ "initialized", "inactive", "active", "closed", "determined", "disputed", "amended", "finalized" ], "type": "string" }, "strike_type": { "description": "Strike type defines how the market strike is defined and evaluated", "enum": [ "greater", "greater_or_equal", "less", "less_or_equal", "between", "functional", "custom", "structured" ], "type": "string", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "subtitle": { "deprecated": true, "type": "string", "x-go-type-skip-optional-pointer": true }, "ticker": { "type": "string" }, "title": { "deprecated": true, "type": "string", "x-go-type-skip-optional-pointer": true }, "updated_time": { "description": "Time of the last non-trading metadata update.", "format": "date-time", "type": "string" }, "volume_24h_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointCount" }, "volume_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointCount" }, "yes_ask_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "yes_ask_size_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointCount" }, "yes_bid_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointDollars" }, "yes_bid_size_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_FixedPointCount" }, "yes_sub_title": { "description": "Shortened title for the yes side of this market", "type": "string" } }, "required": [ "ticker", "event_ticker", "market_type", "yes_sub_title", "no_sub_title", "created_time", "updated_time", "open_time", "close_time", "latest_expiration_time", "settlement_timer_seconds", "status", "notional_value_dollars", "yes_bid_dollars", "yes_ask_dollars", "no_bid_dollars", "no_ask_dollars", "yes_bid_size_fp", "yes_ask_size_fp", "last_price_dollars", "previous_yes_bid_dollars", "previous_yes_ask_dollars", "previous_price_dollars", "volume_fp", "volume_24h_fp", "open_interest_fp", "result", "can_close_early", "expiration_value", "rules_primary", "rules_secondary", "price_level_structure", "price_ranges", "settlement_bounds_type" ], "type": "object" }, "kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_GetMarketsResponse": { "properties": { "cursor": { "type": "string" }, "markets": { "items": { "$ref": "#/components/schemas/kalshi_unauthorized_4c4ca4fdc8b8__Response4Efd2D7Df89E_Market" }, "type": "array" } }, "required": [ "markets", "cursor" ], "type": "object" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_ExchangeIndex": { "description": "Identifier for an exchange shard.", "example": 0, "type": "integer" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars": { "description": "Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., \"0.56\", \"0.5600\"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.", "example": "0.5600", "type": "string" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_MveSelectedLeg": { "properties": { "event_ticker": { "description": "Unique identifier for the selected event", "type": "string", "x-go-type-skip-optional-pointer": true }, "market_ticker": { "description": "Unique identifier for the selected market", "type": "string", "x-go-type-skip-optional-pointer": true }, "side": { "description": "The side of the selected market", "type": "string", "x-go-type-skip-optional-pointer": true }, "yes_settlement_value_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" } }, "type": "object" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointCount": { "description": "Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0-2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts.", "example": "10.00", "type": "string" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_PriceRange": { "properties": { "end": { "description": "Ending price for this range in dollars", "type": "string" }, "start": { "description": "Starting price for this range in dollars", "type": "string" }, "step": { "description": "Price step/tick size for this range in dollars", "type": "string" } }, "required": [ "start", "end", "step" ], "type": "object" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_Market": { "properties": { "can_close_early": { "type": "boolean" }, "cap_strike": { "description": "Maximum expiration value that leads to a YES settlement", "format": "double", "type": [ "number", "null" ], "x-omitempty": true }, "close_time": { "format": "date-time", "type": "string" }, "created_time": { "format": "date-time", "type": "string" }, "custom_strike": { "description": "Expiration value for each target that leads to a YES settlement", "type": [ "object", "null" ], "x-omitempty": true }, "early_close_condition": { "description": "The condition under which the market can close early", "type": [ "string", "null" ], "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "event_ticker": { "type": "string" }, "exchange_index": { "allOf": [ { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_ExchangeIndex" } ], "x-go-type-skip-optional-pointer": true, "x-omitempty": false }, "expected_expiration_time": { "description": "Time when this market is expected to expire", "format": "date-time", "type": [ "string", "null" ], "x-omitempty": true }, "expiration_time": { "deprecated": true, "format": "date-time", "type": "string", "x-go-type-skip-optional-pointer": true }, "expiration_value": { "description": "The value that was considered for the settlement", "type": "string" }, "fee_waiver_expiration_time": { "description": "Time when this market's fee waiver expires", "format": "date-time", "type": [ "string", "null" ], "x-omitempty": true }, "floor_strike": { "description": "Minimum expiration value that leads to a YES settlement", "format": "double", "type": [ "number", "null" ], "x-omitempty": true }, "functional_strike": { "description": "Mapping from expiration values to settlement values", "type": [ "string", "null" ], "x-omitempty": true }, "is_provisional": { "description": "If true, the market may be removed after determination if there is no activity on it", "type": "boolean", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "last_price_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "latest_expiration_time": { "description": "Latest possible time for this market to expire", "format": "date-time", "type": "string" }, "market_type": { "description": "Identifies the type of market", "enum": [ "binary", "scalar" ], "type": "string" }, "mve_collection_ticker": { "description": "The ticker of the multivariate event collection", "type": "string", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "mve_selected_legs": { "items": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_MveSelectedLeg" }, "type": "array", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "no_ask_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "no_bid_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "no_sub_title": { "description": "Shortened title for the no side of this market", "type": "string" }, "notional_value_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "occurrence_datetime": { "description": "The recorded datetime when the underlying event occurred, if available", "format": "date-time", "type": [ "string", "null" ] }, "open_interest_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointCount" }, "open_time": { "format": "date-time", "type": "string" }, "previous_price_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "previous_yes_ask_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "previous_yes_bid_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "price_level_structure": { "description": "Price level structure for this market, defining price ranges and tick sizes", "type": "string" }, "price_ranges": { "description": "Valid price ranges for orders on this market", "items": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_PriceRange" }, "type": "array" }, "primary_participant_key": { "type": [ "string", "null" ], "x-omitempty": true }, "result": { "enum": [ "yes", "no", "scalar", "" ], "type": "string" }, "rules_primary": { "description": "A plain language description of the most important market terms", "type": "string" }, "rules_secondary": { "description": "A plain language description of secondary market terms", "type": "string" }, "settlement_bounds_type": { "description": "Which settlement bounds apply to this market. default means the market has no settlement bounds", "enum": [ "default", "floor" ], "type": "string" }, "settlement_floor_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "settlement_timer_seconds": { "description": "The amount of time after determination that the market settles", "type": "integer" }, "settlement_ts": { "description": "Timestamp when the market was settled. Only filled for settled markets", "format": "date-time", "type": [ "string", "null" ], "x-omitempty": true }, "settlement_value_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "status": { "description": "The current status of the market in its lifecycle.", "enum": [ "initialized", "inactive", "active", "closed", "determined", "disputed", "amended", "finalized" ], "type": "string" }, "strike_type": { "description": "Strike type defines how the market strike is defined and evaluated", "enum": [ "greater", "greater_or_equal", "less", "less_or_equal", "between", "functional", "custom", "structured" ], "type": "string", "x-go-type-skip-optional-pointer": true, "x-omitempty": true }, "subtitle": { "deprecated": true, "type": "string", "x-go-type-skip-optional-pointer": true }, "ticker": { "type": "string" }, "title": { "deprecated": true, "type": "string", "x-go-type-skip-optional-pointer": true }, "updated_time": { "description": "Time of the last non-trading metadata update.", "format": "date-time", "type": "string" }, "volume_24h_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointCount" }, "volume_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointCount" }, "yes_ask_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "yes_ask_size_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointCount" }, "yes_bid_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointDollars" }, "yes_bid_size_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_FixedPointCount" }, "yes_sub_title": { "description": "Shortened title for the yes side of this market", "type": "string" } }, "required": [ "ticker", "event_ticker", "market_type", "yes_sub_title", "no_sub_title", "created_time", "updated_time", "open_time", "close_time", "latest_expiration_time", "settlement_timer_seconds", "status", "notional_value_dollars", "yes_bid_dollars", "yes_ask_dollars", "no_bid_dollars", "no_ask_dollars", "yes_bid_size_fp", "yes_ask_size_fp", "last_price_dollars", "previous_yes_bid_dollars", "previous_yes_ask_dollars", "previous_price_dollars", "volume_fp", "volume_24h_fp", "open_interest_fp", "result", "can_close_early", "expiration_value", "rules_primary", "rules_secondary", "price_level_structure", "price_ranges", "settlement_bounds_type" ], "type": "object" }, "kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_GetMarketResponse": { "properties": { "market": { "$ref": "#/components/schemas/kalshi_unauthorized_9ba02631e218__Response4Efd2D7Df89E_Market" } }, "required": [ "market" ], "type": "object" }, "kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_PriceLevelDollarsCountFp": { "description": "Price level in dollars represented as [dollars_string, fp] where dollars_string is like \"0.1500\" and fp is a FixedPointCount string (fixed-point contract count). The second element is the contract quantity (not price).", "example": [ "0.1500", "100.00" ], "items": { "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_OrderbookCountFp": { "description": "Orderbook with fixed-point contract counts (fp) in all dollar price levels.", "properties": { "no_dollars": { "items": { "$ref": "#/components/schemas/kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_PriceLevelDollarsCountFp" }, "type": "array" }, "yes_dollars": { "items": { "$ref": "#/components/schemas/kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_PriceLevelDollarsCountFp" }, "type": "array" } }, "required": [ "yes_dollars", "no_dollars" ], "type": "object" }, "kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_GetMarketOrderbookResponse": { "properties": { "orderbook_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_691efcfc4aae__Response4Efd2D7Df89E_OrderbookCountFp" } }, "required": [ "orderbook_fp" ], "type": "object" }, "kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_FixedPointCount": { "description": "Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0-2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported; the minimum granularity is 0.01 contracts.", "example": "10.00", "type": "string" }, "kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_FixedPointDollars": { "description": "Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., \"0.56\", \"0.5600\"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.", "example": "0.5600", "type": "string" }, "kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_BookSide": { "description": "Side of the book for an order or trade. For event markets, this refers to the YES leg only: `bid` means buy YES, `ask` means sell YES. (Selling YES is economically equivalent to buying NO at `1 - price`, but this endpoint quotes everything from the YES side.)", "enum": [ "bid", "ask" ], "type": "string" }, "kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_Trade": { "properties": { "count_fp": { "$ref": "#/components/schemas/kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_FixedPointCount" }, "created_time": { "description": "Timestamp when this trade was executed", "format": "date-time", "type": "string" }, "is_block_trade": { "description": "True if this trade was matched off-book as a block trade (e.g. via RFQ / negotiated block proposal); false for trades that filled on the standard order book.", "type": "boolean" }, "no_price_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_FixedPointDollars" }, "taker_book_side": { "$ref": "#/components/schemas/kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_BookSide" }, "taker_outcome_side": { "description": "The outcome side the taker is positioned for. buy-yes and sell-no produce 'yes'; buy-no and sell-yes produce 'no'.\n\n`taker_outcome_side` describes directional exposure only; it does not change the trade's price. A trade at price `p` with `taker_outcome_side=no` is matched against the maker at the same price `p` with the opposite direction \u2014 both parties trade at the same price.\n\n`taker_outcome_side` and `taker_book_side` will become the canonical way to determine trade direction. The legacy `taker_side` field will be deprecated in a future release \u2014 please migrate to these new fields.\n", "enum": [ "yes", "no" ], "type": "string", "x-enum-varnames": [ "TradeTakerOutcomeSideYes", "TradeTakerOutcomeSideNo" ] }, "taker_side": { "deprecated": true, "description": "Deprecated. Use `taker_outcome_side` (or `taker_book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026.\n", "enum": [ "yes", "no" ], "type": "string", "x-enum-varnames": [ "TradeTakerSideYes", "TradeTakerSideNo" ], "x-go-type-skip-optional-pointer": true }, "ticker": { "description": "Unique identifier for the market", "type": "string" }, "trade_id": { "description": "Unique identifier for this trade", "type": "string" }, "yes_price_dollars": { "$ref": "#/components/schemas/kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_FixedPointDollars" } }, "required": [ "trade_id", "ticker", "count_fp", "yes_price_dollars", "no_price_dollars", "taker_outcome_side", "taker_book_side", "created_time", "is_block_trade" ], "type": "object" }, "kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_GetTradesResponse": { "properties": { "cursor": { "type": "string" }, "trades": { "items": { "$ref": "#/components/schemas/kalshi_unauthorized_8fe5edad1cda__Response4Efd2D7Df89E_Trade" }, "type": "array" } }, "required": [ "trades", "cursor" ], "type": "object" }, "polymarket_bridge_a35a1b89cda7__Response7A88Af0Ff8Eb_Token": { "properties": { "address": { "description": "Token contract address", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "type": "string" }, "decimals": { "description": "Token decimals", "example": 6, "type": "integer" }, "name": { "description": "Full token name", "example": "USD Coin", "type": "string" }, "symbol": { "description": "Token symbol", "example": "USDC", "type": "string" } }, "type": "object" }, "polymarket_bridge_a35a1b89cda7__Response7A88Af0Ff8Eb_SupportedAsset": { "properties": { "chainId": { "description": "Chain ID", "example": "1", "type": "string" }, "chainName": { "description": "Human-readable chain name", "example": "Ethereum", "type": "string" }, "minCheckoutUsd": { "description": "Minimum amount in USD for deposits and withdrawals", "example": 45, "type": "number" }, "token": { "$ref": "#/components/schemas/polymarket_bridge_a35a1b89cda7__Response7A88Af0Ff8Eb_Token" } }, "type": "object" }, "polymarket_bridge_a35a1b89cda7__Response7A88Af0Ff8Eb_SupportedAssetsResponse": { "properties": { "supportedAssets": { "description": "List of supported assets with minimum amounts for deposits and withdrawals", "items": { "$ref": "#/components/schemas/polymarket_bridge_a35a1b89cda7__Response7A88Af0Ff8Eb_SupportedAsset" }, "type": "array" } }, "type": "object" }, "polymarket_clob_90dffcdc0caf__Response68C5148660B1_MarketPrice": { "properties": { "p": { "format": "float", "type": "number" }, "t": { "format": "uint32", "type": "integer" } }, "type": "object" }, "polymarket_clob_90dffcdc0caf__Response68C5148660B1_BatchPricesHistoryResponse": { "properties": { "history": { "additionalProperties": { "items": { "$ref": "#/components/schemas/polymarket_clob_90dffcdc0caf__Response68C5148660B1_MarketPrice" }, "type": "array" }, "description": "Map of market asset id to array of price data points.", "type": "object" } }, "type": "object" }, "polymarket_clob_ab921bc8afec__Response68C5148660B1_OrderSummary": { "properties": { "price": { "description": "Order price", "example": "0.45", "type": "string" }, "size": { "description": "Order size", "example": "100", "type": "string" } }, "required": [ "price", "size" ], "type": "object" }, "polymarket_clob_ab921bc8afec__Response68C5148660B1_OrderBookSummary": { "properties": { "asks": { "description": "List of ask orders (sorted by price ascending)", "items": { "$ref": "#/components/schemas/polymarket_clob_ab921bc8afec__Response68C5148660B1_OrderSummary" }, "type": "array" }, "asset_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" }, "bids": { "description": "List of bid orders (sorted by price descending)", "items": { "$ref": "#/components/schemas/polymarket_clob_ab921bc8afec__Response68C5148660B1_OrderSummary" }, "type": "array" }, "hash": { "description": "Hash of the order book summary", "example": "a1b2c3d4e5f6...", "type": "string" }, "last_trade_price": { "description": "Last trade price", "example": "0.45", "type": "string" }, "market": { "description": "Market condition ID", "example": "0x1234567890123456789012345678901234567890", "type": "string" }, "min_order_size": { "description": "Minimum order size", "example": "1", "type": "string" }, "neg_risk": { "description": "Whether negative risk is enabled for this market", "example": false, "type": "boolean" }, "tick_size": { "description": "Minimum price increment (tick size)", "example": "0.01", "type": "string" }, "timestamp": { "description": "Timestamp of the order book snapshot", "example": "1234567890", "type": "string" } }, "required": [ "market", "asset_id", "timestamp", "hash", "bids", "asks", "min_order_size", "tick_size", "neg_risk", "last_trade_price" ], "type": "object" }, "polymarket_clob_9de1af811d71__Response68C5148660B1_OrderSummary": { "properties": { "price": { "description": "Order price", "example": "0.45", "type": "string" }, "size": { "description": "Order size", "example": "100", "type": "string" } }, "required": [ "price", "size" ], "type": "object" }, "polymarket_clob_9de1af811d71__Response68C5148660B1_OrderBookSummary": { "properties": { "asks": { "description": "List of ask orders (sorted by price ascending)", "items": { "$ref": "#/components/schemas/polymarket_clob_9de1af811d71__Response68C5148660B1_OrderSummary" }, "type": "array" }, "asset_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" }, "bids": { "description": "List of bid orders (sorted by price descending)", "items": { "$ref": "#/components/schemas/polymarket_clob_9de1af811d71__Response68C5148660B1_OrderSummary" }, "type": "array" }, "hash": { "description": "Hash of the order book summary", "example": "a1b2c3d4e5f6...", "type": "string" }, "last_trade_price": { "description": "Last trade price", "example": "0.45", "type": "string" }, "market": { "description": "Market condition ID", "example": "0x1234567890123456789012345678901234567890", "type": "string" }, "min_order_size": { "description": "Minimum order size", "example": "1", "type": "string" }, "neg_risk": { "description": "Whether negative risk is enabled for this market", "example": false, "type": "boolean" }, "tick_size": { "description": "Minimum price increment (tick size)", "example": "0.01", "type": "string" }, "timestamp": { "description": "Timestamp of the order book snapshot", "example": "1234567890", "type": "string" } }, "required": [ "market", "asset_id", "timestamp", "hash", "bids", "asks", "min_order_size", "tick_size", "neg_risk", "last_trade_price" ], "type": "object" }, "polymarket_clob_21cb3ed36778__Response68C5148660B1_OrderSummary": { "properties": { "price": { "description": "Order price", "example": "0.45", "type": "string" }, "size": { "description": "Order size", "example": "100", "type": "string" } }, "required": [ "price", "size" ], "type": "object" }, "polymarket_clob_21cb3ed36778__Response68C5148660B1_OrderBookSummary": { "properties": { "asks": { "description": "List of ask orders (sorted by price ascending)", "items": { "$ref": "#/components/schemas/polymarket_clob_21cb3ed36778__Response68C5148660B1_OrderSummary" }, "type": "array" }, "asset_id": { "description": "Token ID (asset ID)", "example": "0xabc123def456...", "type": "string" }, "bids": { "description": "List of bid orders (sorted by price descending)", "items": { "$ref": "#/components/schemas/polymarket_clob_21cb3ed36778__Response68C5148660B1_OrderSummary" }, "type": "array" }, "hash": { "description": "Hash of the order book summary", "example": "a1b2c3d4e5f6...", "type": "string" }, "last_trade_price": { "description": "Last trade price", "example": "0.45", "type": "string" }, "market": { "description": "Market condition ID", "example": "0x1234567890123456789012345678901234567890", "type": "string" }, "min_order_size": { "description": "Minimum order size", "example": "1", "type": "string" }, "neg_risk": { "description": "Whether negative risk is enabled for this market", "example": false, "type": "boolean" }, "tick_size": { "description": "Minimum price increment (tick size)", "example": "0.01", "type": "string" }, "timestamp": { "description": "Timestamp of the order book snapshot", "example": "1234567890", "type": "string" } }, "required": [ "market", "asset_id", "timestamp", "hash", "bids", "asks", "min_order_size", "tick_size", "neg_risk", "last_trade_price" ], "type": "object" }, "polymarket_clob_38987ccbbf6d__Response68C5148660B1_FeeDetails": { "description": "Fee curve parameters for a market.", "properties": { "e": { "description": "Fee curve exponent", "example": 2, "format": "float", "nullable": true, "type": "number" }, "r": { "description": "Fee rate", "example": 0.02, "format": "float", "nullable": true, "type": "number" }, "to": { "description": "Whether fees apply to takers only", "example": true, "nullable": true, "type": "boolean" } }, "type": "object" }, "polymarket_clob_38987ccbbf6d__Response68C5148660B1_ClobRewards": { "additionalProperties": true, "description": "Rewards configuration for a market.", "type": "object" }, "polymarket_clob_38987ccbbf6d__Response68C5148660B1_ClobToken": { "description": "A token in a CLOB market with its ID and outcome label.", "properties": { "o": { "description": "Outcome label for the token (e.g. \"Yes\", \"No\")", "example": "Yes", "type": "string" }, "t": { "description": "The token ID", "example": "71321045679252212594626385532706912750332728571942532289631379312455583992563", "type": "string" } }, "type": "object" }, "polymarket_clob_38987ccbbf6d__Response68C5148660B1_ClobMarketDetails": { "description": "CLOB-level parameters for a market \u2014 tokens, tick size, base fees, rewards, RFQ status, and fee details.", "properties": { "fd": { "$ref": "#/components/schemas/polymarket_clob_38987ccbbf6d__Response68C5148660B1_FeeDetails" }, "gst": { "description": "Game start time (used for sports markets), ISO 8601 timestamp or null", "format": "date-time", "nullable": true, "type": "string" }, "ibce": { "description": "Whether Blockaid check is enabled", "type": "boolean" }, "itode": { "description": "Whether taker order delay is enabled for this market. When true, marketable orders are held for the 250 ms taker-delay window before synchronous processing. This field is omitted when false.", "type": "boolean" }, "mbf": { "description": "Maker base fee in basis points", "example": 0, "format": "int64", "type": "integer" }, "mos": { "description": "Minimum order size", "example": 5, "format": "float", "type": "number" }, "mts": { "description": "Minimum tick size (price increment)", "example": 0.01, "format": "float", "type": "number" }, "oas": { "description": "Minimum order age in seconds", "type": "integer" }, "r": { "$ref": "#/components/schemas/polymarket_clob_38987ccbbf6d__Response68C5148660B1_ClobRewards" }, "rfqe": { "description": "Whether RFQ (Request for Quote) is enabled for this market", "type": "boolean" }, "t": { "description": "Tokens for this market", "items": { "$ref": "#/components/schemas/polymarket_clob_38987ccbbf6d__Response68C5148660B1_ClobToken" }, "type": "array" }, "tbf": { "description": "Taker base fee in basis points", "example": 0, "format": "int64", "type": "integer" } }, "type": "object" }, "polymarket_clob_c6e5254fb848__Response68C5148660B1_FeeRate": { "properties": { "base_fee": { "description": "Base fee in basis points", "example": 30, "format": "int64", "type": "integer" } }, "required": [ "base_fee" ], "type": "object" }, "polymarket_clob_08b984230237__Response68C5148660B1_FeeRate": { "properties": { "base_fee": { "description": "Base fee in basis points", "example": 30, "format": "int64", "type": "integer" } }, "required": [ "base_fee" ], "type": "object" }, "polymarket_clob_6c721edd88f6__Response68C5148660B1_MarketByTokenResponse": { "description": "Response for GET /markets-by-token/{token_id} \u2014 condition ID and both token IDs in the market.", "properties": { "condition_id": { "description": "The condition ID of the market containing the given token", "example": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", "type": "string" }, "primary_token_id": { "description": "The primary (Yes) token ID", "example": "71321045679252212594626385532706912750332728571942532289631379312455583992563", "type": "string" }, "secondary_token_id": { "description": "The secondary (No) token ID", "example": "52114319501245915516055106046884209969926127482827954674443846427813813222426", "type": "string" } }, "required": [ "condition_id", "primary_token_id", "secondary_token_id" ], "type": "object" }, "polymarket_clob_eb5de8209843__Response68C5148660B1_MarketPrice": { "properties": { "p": { "format": "float", "type": "number" }, "t": { "format": "uint32", "type": "integer" } }, "type": "object" }, "polymarket_clob_eb5de8209843__Response68C5148660B1_PricesHistoryResponse": { "properties": { "history": { "items": { "$ref": "#/components/schemas/polymarket_clob_eb5de8209843__Response68C5148660B1_MarketPrice" }, "type": "array" } }, "type": "object" }, "polymarket_clob_1bb98c9b6828__Response68C5148660B1_CurrentRewardConfig": { "description": "Reward configuration entry for a current rewards market", "properties": { "asset_address": { "description": "Address of the reward asset", "type": "string" }, "end_date": { "description": "End date of the rewards period", "format": "date", "type": "string" }, "id": { "description": "Rewards config ID (always 0 on /rewards/markets/current)", "type": "integer" }, "rate_per_day": { "description": "Daily reward rate", "format": "double", "type": "number" }, "start_date": { "description": "Start date of the rewards period", "format": "date", "type": "string" }, "total_rewards": { "description": "Total rewards amount", "format": "double", "type": "number" } }, "required": [ "asset_address", "start_date", "rate_per_day" ], "type": "object" }, "polymarket_clob_1bb98c9b6828__Response68C5148660B1_CurrentReward": { "description": "Current active reward configuration for a market", "properties": { "condition_id": { "description": "Condition ID of the market", "type": "string" }, "native_daily_rate": { "description": "Computed native daily rate excluding sponsors (omitted when zero)", "format": "double", "type": "number" }, "rewards_config": { "items": { "$ref": "#/components/schemas/polymarket_clob_1bb98c9b6828__Response68C5148660B1_CurrentRewardConfig" }, "type": "array" }, "rewards_max_spread": { "description": "Maximum spread for rewards eligibility", "type": "number" }, "rewards_min_size": { "description": "Minimum order size for rewards eligibility", "type": "number" }, "sponsored_daily_rate": { "description": "Sponsored daily rate (omitted when zero)", "format": "double", "type": "number" }, "sponsors_count": { "description": "Number of sponsors (omitted when zero)", "type": "integer" }, "total_daily_rate": { "description": "Computed total daily rate including sponsors (omitted when zero)", "format": "double", "type": "number" } }, "required": [ "condition_id" ], "type": "object" }, "polymarket_clob_1bb98c9b6828__Response68C5148660B1_PaginatedCurrentReward": { "description": "Paginated list of current reward configurations", "properties": { "count": { "description": "Number of items in the current response", "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/polymarket_clob_1bb98c9b6828__Response68C5148660B1_CurrentReward" }, "type": "array" }, "limit": { "description": "Maximum number of items per page", "type": "integer" }, "next_cursor": { "description": "Cursor for the next page. \"LTE=\" indicates the last page.", "type": "string" } }, "required": [ "limit", "count", "next_cursor", "data" ], "type": "object" }, "polymarket_clob_553d0e60d183__Response68C5148660B1_RewardsConfig": { "description": "Rewards configuration for a market", "properties": { "asset_address": { "description": "Address of the reward asset", "type": "string" }, "end_date": { "description": "End date of the rewards period", "format": "date", "type": "string" }, "id": { "description": "Rewards config ID", "type": "integer" }, "rate_per_day": { "description": "Daily reward rate", "format": "double", "type": "number" }, "remaining_reward_amount": { "description": "Remaining reward amount", "format": "double", "type": "number" }, "start_date": { "description": "Start date of the rewards period", "format": "date", "type": "string" }, "total_days": { "description": "Total number of days in the rewards period", "type": "integer" }, "total_rewards": { "description": "Total rewards amount", "format": "double", "type": "number" } }, "required": [ "asset_address", "start_date", "rate_per_day" ], "type": "object" }, "polymarket_clob_553d0e60d183__Response68C5148660B1_RewardsToken": { "description": "Token information for rewards markets", "properties": { "outcome": { "description": "Outcome name (e.g., \"YES\", \"NO\")", "type": "string" }, "price": { "description": "Current price of the token", "format": "double", "type": "number" }, "token_id": { "description": "Token ID", "type": "string" } }, "required": [ "token_id", "outcome" ], "type": "object" }, "polymarket_clob_553d0e60d183__Response68C5148660B1_MultiMarketInfo": { "description": "Market with rewards configuration and trading metrics", "properties": { "condition_id": { "description": "Condition ID of the market", "type": "string" }, "created_at": { "description": "Market creation timestamp", "format": "date-time", "type": "string" }, "end_date": { "description": "Market end date", "type": "string" }, "event_id": { "description": "Event ID", "type": "string" }, "event_slug": { "description": "URL slug for the event", "type": "string" }, "group_item_title": { "description": "Title within an event group", "type": "string" }, "image": { "description": "URL to market image", "type": "string" }, "market_competitiveness": { "description": "Competitiveness score of the market", "format": "double", "type": "number" }, "market_id": { "description": "Market ID", "type": "string" }, "market_slug": { "description": "URL slug for the market", "type": "string" }, "one_day_price_change": { "description": "Price change over the last 24 hours", "format": "double", "type": "number" }, "question": { "description": "Market question", "type": "string" }, "rewards_config": { "items": { "$ref": "#/components/schemas/polymarket_clob_553d0e60d183__Response68C5148660B1_RewardsConfig" }, "type": "array" }, "rewards_max_spread": { "description": "Maximum spread for rewards eligibility", "type": "number" }, "rewards_min_size": { "description": "Minimum order size for rewards eligibility", "type": "number" }, "spread": { "description": "Current spread", "format": "double", "type": "number" }, "tokens": { "items": { "$ref": "#/components/schemas/polymarket_clob_553d0e60d183__Response68C5148660B1_RewardsToken" }, "type": "array" }, "volume_24hr": { "description": "24-hour trading volume", "format": "double", "type": "number" } }, "required": [ "condition_id", "market_id", "question", "tokens" ], "type": "object" }, "polymarket_clob_553d0e60d183__Response68C5148660B1_PaginatedMultiMarketInfo": { "description": "Paginated list of markets with rewards and trading metrics", "properties": { "count": { "description": "Number of items in the current response", "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/polymarket_clob_553d0e60d183__Response68C5148660B1_MultiMarketInfo" }, "type": "array" }, "limit": { "description": "Maximum number of items per page", "type": "integer" }, "next_cursor": { "description": "Cursor for the next page. \"LTE=\" indicates the last page.", "type": "string" } }, "required": [ "limit", "count", "next_cursor", "data" ], "type": "object" }, "polymarket_clob_4599a92b1e7b__Response68C5148660B1_RewardsConfig": { "description": "Rewards configuration for a market", "properties": { "asset_address": { "description": "Address of the reward asset", "type": "string" }, "end_date": { "description": "End date of the rewards period", "format": "date", "type": "string" }, "id": { "description": "Rewards config ID", "type": "integer" }, "rate_per_day": { "description": "Daily reward rate", "format": "double", "type": "number" }, "remaining_reward_amount": { "description": "Remaining reward amount", "format": "double", "type": "number" }, "start_date": { "description": "Start date of the rewards period", "format": "date", "type": "string" }, "total_days": { "description": "Total number of days in the rewards period", "type": "integer" }, "total_rewards": { "description": "Total rewards amount", "format": "double", "type": "number" } }, "required": [ "asset_address", "start_date", "rate_per_day" ], "type": "object" }, "polymarket_clob_4599a92b1e7b__Response68C5148660B1_RewardsToken": { "description": "Token information for rewards markets", "properties": { "outcome": { "description": "Outcome name (e.g., \"YES\", \"NO\")", "type": "string" }, "price": { "description": "Current price of the token", "format": "double", "type": "number" }, "token_id": { "description": "Token ID", "type": "string" } }, "required": [ "token_id", "outcome" ], "type": "object" }, "polymarket_clob_4599a92b1e7b__Response68C5148660B1_MarketReward": { "description": "Market with raw reward configurations", "properties": { "condition_id": { "description": "Condition ID of the market", "type": "string" }, "event_slug": { "description": "URL slug for the event", "type": "string" }, "image": { "description": "URL to market image", "type": "string" }, "market_competitiveness": { "description": "Competitiveness score of the market", "format": "double", "type": "number" }, "market_slug": { "description": "URL slug for the market", "type": "string" }, "question": { "description": "Market question", "type": "string" }, "rewards_config": { "items": { "$ref": "#/components/schemas/polymarket_clob_4599a92b1e7b__Response68C5148660B1_RewardsConfig" }, "type": "array" }, "rewards_max_spread": { "description": "Maximum spread for rewards eligibility", "type": "number" }, "rewards_min_size": { "description": "Minimum order size for rewards eligibility", "type": "number" }, "tokens": { "items": { "$ref": "#/components/schemas/polymarket_clob_4599a92b1e7b__Response68C5148660B1_RewardsToken" }, "type": "array" } }, "required": [ "condition_id", "question", "tokens" ], "type": "object" }, "polymarket_clob_4599a92b1e7b__Response68C5148660B1_PaginatedMarketReward": { "description": "Paginated list of market reward configurations", "properties": { "count": { "description": "Number of items in the current response", "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/polymarket_clob_4599a92b1e7b__Response68C5148660B1_MarketReward" }, "type": "array" }, "limit": { "description": "Maximum number of items per page", "type": "integer" }, "next_cursor": { "description": "Cursor for the next page. \"LTE=\" indicates the last page.", "type": "string" } }, "required": [ "limit", "count", "next_cursor", "data" ], "type": "object" }, "polymarket_clob_cee92151ea24__Response68C5148660B1_Rewards": { "properties": { "max_spread": { "format": "double", "type": "number" }, "min_size": { "format": "double", "type": "number" }, "rates": { "items": { "properties": { "asset_address": { "type": "string" }, "rewards_daily_rate": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "polymarket_clob_cee92151ea24__Response68C5148660B1_Token": { "properties": { "outcome": { "type": "string" }, "price": { "format": "double", "type": "number" }, "token_id": { "type": "string" }, "winner": { "type": "boolean" } }, "type": "object" }, "polymarket_clob_cee92151ea24__Response68C5148660B1_Market": { "properties": { "accepting_order_timestamp": { "format": "date-time", "type": "string" }, "accepting_orders": { "type": "boolean" }, "active": { "type": "boolean" }, "archived": { "type": "boolean" }, "closed": { "type": "boolean" }, "condition_id": { "type": "string" }, "description": { "type": "string" }, "enable_order_book": { "type": "boolean" }, "end_date_iso": { "format": "date-time", "type": "string" }, "fpmm": { "type": "string" }, "game_start_time": { "format": "date-time", "type": "string" }, "icon": { "type": "string" }, "image": { "type": "string" }, "is_50_50_outcome": { "type": "boolean" }, "maker_base_fee": { "format": "int64", "type": "integer" }, "market_slug": { "type": "string" }, "minimum_order_size": { "format": "double", "type": "number" }, "minimum_tick_size": { "format": "double", "type": "number" }, "neg_risk": { "type": "boolean" }, "neg_risk_market_id": { "type": "string" }, "neg_risk_request_id": { "type": "string" }, "notifications_enabled": { "type": "boolean" }, "question": { "type": "string" }, "question_id": { "type": "string" }, "rewards": { "$ref": "#/components/schemas/polymarket_clob_cee92151ea24__Response68C5148660B1_Rewards" }, "seconds_delay": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "taker_base_fee": { "format": "int64", "type": "integer" }, "tokens": { "items": { "$ref": "#/components/schemas/polymarket_clob_cee92151ea24__Response68C5148660B1_Token" }, "type": "array" } }, "type": "object" }, "polymarket_clob_cee92151ea24__Response68C5148660B1_PaginatedMarkets": { "properties": { "count": { "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/polymarket_clob_cee92151ea24__Response68C5148660B1_Market" }, "type": "array" }, "limit": { "type": "integer" }, "next_cursor": { "type": "string" } }, "type": "object" }, "polymarket_clob_84e3aef08472__Response68C5148660B1_Rewards": { "properties": { "max_spread": { "format": "double", "type": "number" }, "min_size": { "format": "double", "type": "number" }, "rates": { "items": { "properties": { "asset_address": { "type": "string" }, "rewards_daily_rate": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "polymarket_clob_84e3aef08472__Response68C5148660B1_Token": { "properties": { "outcome": { "type": "string" }, "price": { "format": "double", "type": "number" }, "token_id": { "type": "string" }, "winner": { "type": "boolean" } }, "type": "object" }, "polymarket_clob_84e3aef08472__Response68C5148660B1_SimplifiedMarket": { "properties": { "accepting_orders": { "type": "boolean" }, "active": { "type": "boolean" }, "archived": { "type": "boolean" }, "closed": { "type": "boolean" }, "condition_id": { "type": "string" }, "rewards": { "$ref": "#/components/schemas/polymarket_clob_84e3aef08472__Response68C5148660B1_Rewards" }, "tokens": { "items": { "$ref": "#/components/schemas/polymarket_clob_84e3aef08472__Response68C5148660B1_Token" }, "type": "array" } }, "type": "object" }, "polymarket_clob_84e3aef08472__Response68C5148660B1_PaginatedSimplifiedMarkets": { "properties": { "count": { "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/polymarket_clob_84e3aef08472__Response68C5148660B1_SimplifiedMarket" }, "type": "array" }, "limit": { "type": "integer" }, "next_cursor": { "type": "string" } }, "type": "object" }, "polymarket_clob_ab9f10d53db3__Response68C5148660B1_Rewards": { "properties": { "max_spread": { "format": "double", "type": "number" }, "min_size": { "format": "double", "type": "number" }, "rates": { "items": { "properties": { "asset_address": { "type": "string" }, "rewards_daily_rate": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "polymarket_clob_ab9f10d53db3__Response68C5148660B1_Token": { "properties": { "outcome": { "type": "string" }, "price": { "format": "double", "type": "number" }, "token_id": { "type": "string" }, "winner": { "type": "boolean" } }, "type": "object" }, "polymarket_clob_ab9f10d53db3__Response68C5148660B1_SimplifiedMarket": { "properties": { "accepting_orders": { "type": "boolean" }, "active": { "type": "boolean" }, "archived": { "type": "boolean" }, "closed": { "type": "boolean" }, "condition_id": { "type": "string" }, "rewards": { "$ref": "#/components/schemas/polymarket_clob_ab9f10d53db3__Response68C5148660B1_Rewards" }, "tokens": { "items": { "$ref": "#/components/schemas/polymarket_clob_ab9f10d53db3__Response68C5148660B1_Token" }, "type": "array" } }, "type": "object" }, "polymarket_clob_ab9f10d53db3__Response68C5148660B1_PaginatedSimplifiedMarkets": { "properties": { "count": { "type": "integer" }, "data": { "items": { "$ref": "#/components/schemas/polymarket_clob_ab9f10d53db3__Response68C5148660B1_SimplifiedMarket" }, "type": "array" }, "limit": { "type": "integer" }, "next_cursor": { "type": "string" } }, "type": "object" }, "polymarket_clob_6ad1f9f9b2f3__Response68C5148660B1_TickSize": { "properties": { "minimum_tick_size": { "description": "Minimum tick size (price increment)", "example": 0.01, "format": "double", "type": "number" } }, "required": [ "minimum_tick_size" ], "type": "object" }, "polymarket_clob_8305185169e4__Response68C5148660B1_TickSize": { "properties": { "minimum_tick_size": { "description": "Minimum tick size (price increment)", "example": 0.01, "format": "double", "type": "number" } }, "required": [ "minimum_tick_size" ], "type": "object" }, "polymarket_data_b80dbc0fafd4__Response65D835437A58_Hash64": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "polymarket_data_b80dbc0fafd4__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_b80dbc0fafd4__Response65D835437A58_Activity": { "properties": { "asset": { "description": "Token ID this row refers to. Populated on `REDEEM` rows with the token that row settles. Empty when the row is not token-specific.", "type": "string" }, "bio": { "type": "string" }, "conditionId": { "$ref": "#/components/schemas/polymarket_data_b80dbc0fafd4__Response65D835437A58_Hash64" }, "eventSlug": { "type": "string" }, "icon": { "description": "Market artwork. Falls back to the market image, then to the parent event's icon and image, when the market has no icon of its own. Empty on `CONVERSION` rows.", "type": "string" }, "isCombo": { "description": "True when this row is part of a combinatorial (multi-market) position. Flag only \u2014 combo detail is not embedded here. The row's conditionId equals the combo's combo_condition_id; pass it to /v1/activity/combos or /v1/positions/combos via market_id to fetch legs and detail. Omitted on non-combo rows.", "type": "boolean" }, "name": { "type": "string" }, "outcome": { "type": "string" }, "outcomeIndex": { "description": "Zero-based index of this row's outcome in the market's `outcomes` array, so `outcome` always equals `outcomes[outcomeIndex]`. On `REDEEM` rows it identifies the outcome the row settles, not the market's winning outcome. `999` means the outcome could not be determined, in which case `outcome` is empty.", "type": "integer" }, "price": { "type": "number" }, "profileImage": { "type": "string" }, "profileImageOptimized": { "type": "string" }, "proxyWallet": { "$ref": "#/components/schemas/polymarket_data_b80dbc0fafd4__Response65D835437A58_Address" }, "pseudonym": { "type": "string" }, "side": { "enum": [ "BUY", "SELL" ], "type": "string" }, "size": { "description": "Token amount for this row. On `REDEEM` rows it is the number of tokens burned for this row's outcome, so redeeming both sides of a market returns one row per outcome instead of a single combined row.", "type": "number" }, "slug": { "type": "string" }, "timestamp": { "format": "int64", "type": "integer" }, "title": { "type": "string" }, "transactionHash": { "type": "string" }, "type": { "enum": [ "TRADE", "SPLIT", "MERGE", "REDEEM", "REWARD", "CONVERSION", "DEPOSIT", "WITHDRAWAL", "YIELD", "MAKER_REBATE", "TAKER_REBATE", "REFERRAL_REWARD" ], "type": "string" }, "usdcSize": { "description": "USDC amount for this row. On `REDEEM` rows it is the payout for this row's outcome and is `0` for a losing outcome; the rows of one redemption sum to the total payout.", "type": "number" } }, "type": "object" }, "polymarket_data_f293eb424810__Response65D835437A58_Hash64": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "polymarket_data_f293eb424810__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_f293eb424810__Response65D835437A58_ClosedPosition": { "properties": { "asset": { "type": "string" }, "avgPrice": { "type": "number" }, "conditionId": { "$ref": "#/components/schemas/polymarket_data_f293eb424810__Response65D835437A58_Hash64" }, "curPrice": { "type": "number" }, "endDate": { "type": "string" }, "eventSlug": { "type": "string" }, "icon": { "type": "string" }, "oppositeAsset": { "type": "string" }, "oppositeOutcome": { "type": "string" }, "outcome": { "type": "string" }, "outcomeIndex": { "type": "integer" }, "proxyWallet": { "$ref": "#/components/schemas/polymarket_data_f293eb424810__Response65D835437A58_Address" }, "realizedPnl": { "type": "number" }, "slug": { "type": "string" }, "timestamp": { "format": "int64", "type": "integer" }, "title": { "type": "string" }, "totalBought": { "type": "number" } }, "type": "object" }, "polymarket_data_31311d8c5221__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_31311d8c5221__Response65D835437A58_Holder": { "properties": { "amount": { "type": "number" }, "asset": { "type": "string" }, "bio": { "type": "string" }, "displayUsernamePublic": { "type": "boolean" }, "name": { "type": "string" }, "outcomeIndex": { "type": "integer" }, "profileImage": { "type": "string" }, "profileImageOptimized": { "type": "string" }, "proxyWallet": { "$ref": "#/components/schemas/polymarket_data_31311d8c5221__Response65D835437A58_Address" }, "pseudonym": { "type": "string" } }, "type": "object" }, "polymarket_data_31311d8c5221__Response65D835437A58_MetaHolder": { "properties": { "holders": { "items": { "$ref": "#/components/schemas/polymarket_data_31311d8c5221__Response65D835437A58_Holder" }, "type": "array" }, "token": { "type": "string" } }, "type": "object" }, "polymarket_data_02738f46225f__Response65D835437A58_Hash64": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "polymarket_data_02738f46225f__Response65D835437A58_MarketVolume": { "properties": { "market": { "$ref": "#/components/schemas/polymarket_data_02738f46225f__Response65D835437A58_Hash64" }, "value": { "type": "number" } }, "type": "object" }, "polymarket_data_02738f46225f__Response65D835437A58_LiveVolume": { "properties": { "markets": { "items": { "$ref": "#/components/schemas/polymarket_data_02738f46225f__Response65D835437A58_MarketVolume" }, "type": "array" }, "total": { "type": "number" } }, "type": "object" }, "polymarket_data_4872c30d3c60__Response65D835437A58_Hash64": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "polymarket_data_4872c30d3c60__Response65D835437A58_OpenInterest": { "properties": { "market": { "$ref": "#/components/schemas/polymarket_data_4872c30d3c60__Response65D835437A58_Hash64" }, "value": { "type": "number" } }, "type": "object" }, "polymarket_data_22184f5f2aab__Response65D835437A58_Hash64": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "polymarket_data_22184f5f2aab__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_22184f5f2aab__Response65D835437A58_Position": { "properties": { "asset": { "type": "string" }, "avgPrice": { "type": "number" }, "cashPnl": { "type": "number" }, "conditionId": { "$ref": "#/components/schemas/polymarket_data_22184f5f2aab__Response65D835437A58_Hash64" }, "curPrice": { "type": "number" }, "currentValue": { "type": "number" }, "endDate": { "type": "string" }, "entryFeesUsdc": { "description": "Attributed BUY-fee component of `grossInitialValue`, at six-decimal source precision. SELL fees are exit costs and are never included. Returned as an explicit `0` when the fee component is zero. Optional: treat an omitted field as unavailable rather than as zero.", "type": "number" }, "eventSlug": { "type": "string" }, "grossInitialValue": { "description": "Remaining entry basis including attributed BUY fees, at six-decimal source precision. `initialValue` and `avgPrice` keep their fee-exclusive semantics, so the fee-exclusive basis is `grossInitialValue - entryFeesUsdc`. Optional: treat an omitted field as unavailable rather than as zero.", "type": "number" }, "icon": { "type": "string" }, "initialValue": { "type": "number" }, "mergeable": { "type": "boolean" }, "negativeRisk": { "type": "boolean" }, "oppositeAsset": { "type": "string" }, "oppositeOutcome": { "type": "string" }, "outcome": { "type": "string" }, "outcomeIndex": { "type": "integer" }, "percentPnl": { "type": "number" }, "percentRealizedPnl": { "type": "number" }, "proxyWallet": { "$ref": "#/components/schemas/polymarket_data_22184f5f2aab__Response65D835437A58_Address" }, "realizedPnl": { "type": "number" }, "redeemable": { "type": "boolean" }, "size": { "type": "number" }, "slug": { "type": "string" }, "title": { "type": "string" }, "totalBought": { "type": "number" } }, "type": "object" }, "polymarket_data_98db2fb30124__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_98db2fb30124__Response65D835437A58_Traded": { "properties": { "traded": { "type": "integer" }, "user": { "$ref": "#/components/schemas/polymarket_data_98db2fb30124__Response65D835437A58_Address" } }, "type": "object" }, "polymarket_data_351a5fa3e498__Response65D835437A58_LeaderboardEntry": { "properties": { "activeUsers": { "description": "Number of active users for this builder", "type": "integer" }, "builder": { "description": "The builder name or identifier", "type": "string" }, "builderCode": { "description": "The builder's onchain attribution code as attached to orders via `builderCode` (see CLOB V2). Empty string for legacy builders without a registered code.", "type": "string" }, "builderLogo": { "description": "URL to the builder's logo image", "type": "string" }, "rank": { "description": "The rank position of the builder", "type": "string" }, "verified": { "description": "Whether the builder is verified", "type": "boolean" }, "volume": { "description": "Total trading volume attributed to this builder", "type": "number" } }, "type": "object" }, "polymarket_data_341c90dce1ab__Response65D835437A58_BuilderVolumeEntry": { "properties": { "activeUsers": { "description": "Number of active users for this builder on this date", "type": "integer" }, "builder": { "description": "The builder name or identifier", "type": "string" }, "builderCode": { "description": "The builder's onchain attribution code as attached to orders via `builderCode` (see CLOB V2). Empty string for legacy builders without a registered code.", "type": "string" }, "builderLogo": { "description": "URL to the builder's logo image", "type": "string" }, "dt": { "description": "The timestamp for this volume entry in ISO 8601 format", "example": "2025-11-15T00:00:00Z", "format": "date-time", "type": "string" }, "rank": { "description": "The rank position of the builder on this date", "type": "string" }, "verified": { "description": "Whether the builder is verified", "type": "boolean" }, "volume": { "description": "Trading volume for this builder on this date", "type": "number" } }, "type": "object" }, "polymarket_data_ad51d09635a6__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_ad51d09635a6__Response65D835437A58_TraderLeaderboardEntry": { "properties": { "pnl": { "description": "Profit and loss for this trader", "type": "number" }, "profileImage": { "description": "URL to the trader's profile image", "type": "string" }, "proxyWallet": { "$ref": "#/components/schemas/polymarket_data_ad51d09635a6__Response65D835437A58_Address" }, "rank": { "description": "The rank position of the trader", "type": "string" }, "userName": { "description": "The trader's username", "type": "string" }, "verifiedBadge": { "description": "Whether the trader has a verified badge", "type": "boolean" }, "vol": { "description": "Trading volume for this trader", "type": "number" }, "xUsername": { "description": "The trader's X (Twitter) username", "type": "string" } }, "type": "object" }, "polymarket_data_45a4e04908fc__Response65D835437A58_Hash64": { "description": "0x-prefixed 64-hex string", "example": "0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917", "pattern": "^0x[a-fA-F0-9]{64}$", "type": "string" }, "polymarket_data_45a4e04908fc__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_45a4e04908fc__Response65D835437A58_MarketPositionV1": { "properties": { "asset": { "type": "string" }, "avgPrice": { "type": "number" }, "cashPnl": { "type": "number" }, "conditionId": { "$ref": "#/components/schemas/polymarket_data_45a4e04908fc__Response65D835437A58_Hash64" }, "currPrice": { "type": "number" }, "currentValue": { "type": "number" }, "name": { "type": "string" }, "outcome": { "type": "string" }, "outcomeIndex": { "type": "integer" }, "profileImage": { "type": "string" }, "proxyWallet": { "$ref": "#/components/schemas/polymarket_data_45a4e04908fc__Response65D835437A58_Address" }, "realizedPnl": { "type": "number" }, "size": { "type": "number" }, "totalBought": { "type": "number" }, "totalPnl": { "type": "number" }, "verified": { "type": "boolean" } }, "type": "object" }, "polymarket_data_45a4e04908fc__Response65D835437A58_MetaMarketPositionV1": { "properties": { "positions": { "items": { "$ref": "#/components/schemas/polymarket_data_45a4e04908fc__Response65D835437A58_MarketPositionV1" }, "type": "array" }, "token": { "description": "The outcome token asset ID", "type": "string" } }, "type": "object" }, "polymarket_data_6c308ca67cf6__Response65D835437A58_Address": { "description": "User Profile Address (0x-prefixed, 40 hex chars)", "example": "0x56687bf447db6ffa42ffe2204a05edaa20f55839", "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" }, "polymarket_data_6c308ca67cf6__Response65D835437A58_Value": { "properties": { "user": { "$ref": "#/components/schemas/polymarket_data_6c308ca67cf6__Response65D835437A58_Address" }, "value": { "type": "number" } }, "type": "object" }, "polymarket_gamma_83be8d2e6735__Response8689C55A3B97_CommentPosition": { "properties": { "positionSize": { "type": [ "string", "null" ] }, "tokenId": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_83be8d2e6735__Response8689C55A3B97_ImageOptimization": { "properties": { "field": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "imageOptimizedComplete": { "type": [ "boolean", "null" ] }, "imageOptimizedLastUpdated": { "type": [ "string", "null" ] }, "imageSizeKbOptimized": { "type": [ "number", "null" ] }, "imageSizeKbSource": { "type": [ "number", "null" ] }, "imageUrlOptimized": { "type": [ "string", "null" ] }, "imageUrlSource": { "type": [ "string", "null" ] }, "relID": { "type": [ "integer", "null" ] }, "relname": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_83be8d2e6735__Response8689C55A3B97_CommentProfile": { "properties": { "baseAddress": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "displayUsernamePublic": { "type": [ "boolean", "null" ] }, "isCreator": { "type": [ "boolean", "null" ] }, "isMod": { "type": [ "boolean", "null" ] }, "name": { "type": [ "string", "null" ] }, "positions": { "items": { "$ref": "#/components/schemas/polymarket_gamma_83be8d2e6735__Response8689C55A3B97_CommentPosition" }, "type": "array" }, "profileImage": { "type": [ "string", "null" ] }, "profileImageOptimized": { "$ref": "#/components/schemas/polymarket_gamma_83be8d2e6735__Response8689C55A3B97_ImageOptimization" }, "proxyWallet": { "type": [ "string", "null" ] }, "pseudonym": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_83be8d2e6735__Response8689C55A3B97_Reaction": { "properties": { "commentID": { "type": [ "integer", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "profile": { "$ref": "#/components/schemas/polymarket_gamma_83be8d2e6735__Response8689C55A3B97_CommentProfile" }, "reactionType": { "type": [ "string", "null" ] }, "userAddress": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_83be8d2e6735__Response8689C55A3B97_Comment": { "properties": { "body": { "type": [ "string", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "parentCommentID": { "type": [ "string", "null" ] }, "parentEntityID": { "type": [ "integer", "null" ] }, "parentEntityType": { "type": [ "string", "null" ] }, "profile": { "$ref": "#/components/schemas/polymarket_gamma_83be8d2e6735__Response8689C55A3B97_CommentProfile" }, "reactionCount": { "type": [ "integer", "null" ] }, "reactions": { "items": { "$ref": "#/components/schemas/polymarket_gamma_83be8d2e6735__Response8689C55A3B97_Reaction" }, "type": "array" }, "replyAddress": { "type": [ "string", "null" ] }, "reportCount": { "type": [ "integer", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "userAddress": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_3abab4d1129f__Response8689C55A3B97_CommentPosition": { "properties": { "positionSize": { "type": [ "string", "null" ] }, "tokenId": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_3abab4d1129f__Response8689C55A3B97_ImageOptimization": { "properties": { "field": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "imageOptimizedComplete": { "type": [ "boolean", "null" ] }, "imageOptimizedLastUpdated": { "type": [ "string", "null" ] }, "imageSizeKbOptimized": { "type": [ "number", "null" ] }, "imageSizeKbSource": { "type": [ "number", "null" ] }, "imageUrlOptimized": { "type": [ "string", "null" ] }, "imageUrlSource": { "type": [ "string", "null" ] }, "relID": { "type": [ "integer", "null" ] }, "relname": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_3abab4d1129f__Response8689C55A3B97_CommentProfile": { "properties": { "baseAddress": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "displayUsernamePublic": { "type": [ "boolean", "null" ] }, "isCreator": { "type": [ "boolean", "null" ] }, "isMod": { "type": [ "boolean", "null" ] }, "name": { "type": [ "string", "null" ] }, "positions": { "items": { "$ref": "#/components/schemas/polymarket_gamma_3abab4d1129f__Response8689C55A3B97_CommentPosition" }, "type": "array" }, "profileImage": { "type": [ "string", "null" ] }, "profileImageOptimized": { "$ref": "#/components/schemas/polymarket_gamma_3abab4d1129f__Response8689C55A3B97_ImageOptimization" }, "proxyWallet": { "type": [ "string", "null" ] }, "pseudonym": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_3abab4d1129f__Response8689C55A3B97_Reaction": { "properties": { "commentID": { "type": [ "integer", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "profile": { "$ref": "#/components/schemas/polymarket_gamma_3abab4d1129f__Response8689C55A3B97_CommentProfile" }, "reactionType": { "type": [ "string", "null" ] }, "userAddress": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_3abab4d1129f__Response8689C55A3B97_Comment": { "properties": { "body": { "type": [ "string", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "parentCommentID": { "type": [ "string", "null" ] }, "parentEntityID": { "type": [ "integer", "null" ] }, "parentEntityType": { "type": [ "string", "null" ] }, "profile": { "$ref": "#/components/schemas/polymarket_gamma_3abab4d1129f__Response8689C55A3B97_CommentProfile" }, "reactionCount": { "type": [ "integer", "null" ] }, "reactions": { "items": { "$ref": "#/components/schemas/polymarket_gamma_3abab4d1129f__Response8689C55A3B97_Reaction" }, "type": "array" }, "replyAddress": { "type": [ "string", "null" ] }, "reportCount": { "type": [ "integer", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "userAddress": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_afcea9ec2990__Response8689C55A3B97_CommentPosition": { "properties": { "positionSize": { "type": [ "string", "null" ] }, "tokenId": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_afcea9ec2990__Response8689C55A3B97_ImageOptimization": { "properties": { "field": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "imageOptimizedComplete": { "type": [ "boolean", "null" ] }, "imageOptimizedLastUpdated": { "type": [ "string", "null" ] }, "imageSizeKbOptimized": { "type": [ "number", "null" ] }, "imageSizeKbSource": { "type": [ "number", "null" ] }, "imageUrlOptimized": { "type": [ "string", "null" ] }, "imageUrlSource": { "type": [ "string", "null" ] }, "relID": { "type": [ "integer", "null" ] }, "relname": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_afcea9ec2990__Response8689C55A3B97_CommentProfile": { "properties": { "baseAddress": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] }, "displayUsernamePublic": { "type": [ "boolean", "null" ] }, "isCreator": { "type": [ "boolean", "null" ] }, "isMod": { "type": [ "boolean", "null" ] }, "name": { "type": [ "string", "null" ] }, "positions": { "items": { "$ref": "#/components/schemas/polymarket_gamma_afcea9ec2990__Response8689C55A3B97_CommentPosition" }, "type": "array" }, "profileImage": { "type": [ "string", "null" ] }, "profileImageOptimized": { "$ref": "#/components/schemas/polymarket_gamma_afcea9ec2990__Response8689C55A3B97_ImageOptimization" }, "proxyWallet": { "type": [ "string", "null" ] }, "pseudonym": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_afcea9ec2990__Response8689C55A3B97_Reaction": { "properties": { "commentID": { "type": [ "integer", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "profile": { "$ref": "#/components/schemas/polymarket_gamma_afcea9ec2990__Response8689C55A3B97_CommentProfile" }, "reactionType": { "type": [ "string", "null" ] }, "userAddress": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_afcea9ec2990__Response8689C55A3B97_Comment": { "properties": { "body": { "type": [ "string", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "parentCommentID": { "type": [ "string", "null" ] }, "parentEntityID": { "type": [ "integer", "null" ] }, "parentEntityType": { "type": [ "string", "null" ] }, "profile": { "$ref": "#/components/schemas/polymarket_gamma_afcea9ec2990__Response8689C55A3B97_CommentProfile" }, "reactionCount": { "type": [ "integer", "null" ] }, "reactions": { "items": { "$ref": "#/components/schemas/polymarket_gamma_afcea9ec2990__Response8689C55A3B97_Reaction" }, "type": "array" }, "replyAddress": { "type": [ "string", "null" ] }, "reportCount": { "type": [ "integer", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "userAddress": { "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_90f1b7f81e46__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_785977d6068a__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_91347b3da84c__Response8689C55A3B97_PublicProfileUser": { "description": "User object associated with a public profile", "properties": { "creator": { "description": "Whether the user is a creator", "type": "boolean" }, "id": { "description": "User ID", "type": "string" }, "mod": { "description": "Whether the user is a moderator", "type": "boolean" } }, "type": "object" }, "polymarket_gamma_91347b3da84c__Response8689C55A3B97_PublicProfileResponse": { "properties": { "bio": { "description": "Profile bio", "type": [ "string", "null" ] }, "createdAt": { "description": "ISO 8601 timestamp of when the profile was created", "format": "date-time", "type": [ "string", "null" ] }, "displayUsernamePublic": { "description": "Whether the username is displayed publicly", "type": [ "boolean", "null" ] }, "name": { "description": "User-chosen display name", "type": [ "string", "null" ] }, "profileImage": { "description": "URL to the profile image", "format": "uri", "type": [ "string", "null" ] }, "proxyWallet": { "description": "The proxy wallet address", "type": [ "string", "null" ] }, "pseudonym": { "description": "Auto-generated pseudonym", "type": [ "string", "null" ] }, "users": { "description": "Array of associated user objects", "items": { "$ref": "#/components/schemas/polymarket_gamma_91347b3da84c__Response8689C55A3B97_PublicProfileUser" }, "type": [ "array", "null" ] }, "verifiedBadge": { "description": "Whether the profile has a verified badge", "type": [ "boolean", "null" ] }, "xUsername": { "description": "X (Twitter) username", "type": [ "string", "null" ] } }, "type": "object" }, "polymarket_gamma_9ee1b4ac4904__Response8689C55A3B97_SportsMetadata": { "properties": { "image": { "description": "URL to the sport's logo or image asset", "format": "uri", "type": "string" }, "ordering": { "description": "Preferred ordering for sport display, typically \"home\" or \"away\"", "type": "string" }, "resolution": { "description": "URL to the official resolution source for the sport (e.g., league website)", "format": "uri", "type": "string" }, "series": { "description": "Series identifier linking the sport to a specific tournament or season series", "type": "string" }, "sport": { "description": "The sport identifier or abbreviation", "type": "string" }, "tags": { "description": "Comma-separated list of tag IDs associated with the sport for categorization and filtering", "type": "string" } }, "type": "object" }, "polymarket_gamma_61af7877d745__Response8689C55A3B97_SportsMarketTypesResponse": { "properties": { "marketTypes": { "description": "List of all valid sports market types", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "polymarket_gamma_ab2a847f055c__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_78ec97965363__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_35fa5e300173__Response8689C55A3B97_RelatedTag": { "properties": { "id": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "relatedTagID": { "type": [ "integer", "null" ] }, "tagID": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_a6e411ef833a__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_c4db0c4308fd__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_1a1a0b0bbdd4__Response8689C55A3B97_RelatedTag": { "properties": { "id": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "relatedTagID": { "type": [ "integer", "null" ] }, "tagID": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_c698b43e93ad__Response8689C55A3B97_Tag": { "properties": { "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "createdBy": { "type": [ "integer", "null" ] }, "forceHide": { "type": [ "boolean", "null" ] }, "forceShow": { "type": [ "boolean", "null" ] }, "id": { "type": "string" }, "isCarousel": { "type": [ "boolean", "null" ] }, "label": { "type": [ "string", "null" ] }, "publishedAt": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "updatedBy": { "type": [ "integer", "null" ] } }, "type": "object" }, "polymarket_gamma_1153b9cce798__Response8689C55A3B97_Team": { "properties": { "abbreviation": { "type": [ "string", "null" ] }, "alias": { "type": [ "string", "null" ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "integer" }, "league": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "record": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "scholar_3b73ab6b6162__Response8Da310D1D213_ExplainSearchResponse": { "description": "JSON explanation response returned when response_mode is NON_STREAMING.", "properties": { "message": { "description": "Generated explanation text.", "type": "string" } }, "required": [ "message" ], "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_Pagination": { "properties": { "next_page_token": { "description": "Token to retrieve the next page of results", "type": "string" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_GpsCoordinates": { "properties": { "latitude": { "description": "Latitude coordinate", "type": "number" }, "longitude": { "description": "Longitude coordinate", "type": "number" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_PriceBreakdownItem": { "properties": { "description": { "description": "Breakdown item description", "type": "string" }, "extracted_price": { "description": "Numeric breakdown item price. Signed, so discount lines are negative and the lines sum to the total.", "type": "number" }, "price": { "description": "Breakdown item price display text", "type": "string" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_Price": { "properties": { "breakdown": { "description": "Every itemized price line: the stay subtotal, any discount lines, any tax or fee lines, and the total. The lines sum to the total, so a listing's taxes are read from here rather than from a single field, since a card can carry several tax lines. Line descriptions are localized to the airbnb_domain.", "items": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_PriceBreakdownItem" }, "type": "array" }, "discount": { "description": "Discount amount display text", "type": "string" }, "extracted_discount": { "description": "Numeric discount value", "type": "number" }, "extracted_original_price": { "description": "Numeric original price value", "type": "number" }, "extracted_price_per_qualifier": { "description": "Numeric price per qualifier value", "type": "number" }, "extracted_qualifier": { "description": "Numeric qualifier value", "type": "integer" }, "extracted_total_price": { "description": "Numeric total price value", "type": "number" }, "extracted_total_with_taxes": { "description": "Numeric all-in total extracted from `total_with_taxes`", "type": "number" }, "original_price": { "description": "Original price before discount", "type": "string" }, "price_per_qualifier": { "description": "Price breakdown per qualifier", "type": "string" }, "qualifier": { "description": "Price qualifier text (e.g., per night, per week)", "type": "string" }, "total_price": { "description": "Total price display text", "type": "string" }, "total_with_taxes": { "description": "Formatted all-in total including taxes and fees. Exact, where `total_price` is Airbnb's rounded display figure. Present only when Airbnb provides an all-in figure, so its absence means no tax-inclusive price was available.", "type": "string" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_Property": { "properties": { "accommodations": { "description": "Accommodation details (bedrooms, beds, bathrooms)", "items": { "type": "string" }, "type": "array" }, "badges": { "description": "Property badges (e.g., Guest favorite, Superhost)", "items": { "type": "string" }, "type": "array" }, "booking_link": { "description": "Direct booking URL with dates and guest parameters", "type": "string" }, "check_in_date": { "description": "Check-in date for this property", "type": "string" }, "check_out_date": { "description": "Check-out date for this property", "type": "string" }, "description": { "description": "Property description", "type": "string" }, "distance": { "description": "Distance from search location", "type": "string" }, "extracted_distance": { "description": "Numeric distance value", "type": "number" }, "gps_coordinates": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_GpsCoordinates" }, "has_free_cancellation": { "description": "Present and true when the card shows a \"Free cancellation\" highlight. Omitted otherwise.", "type": "boolean" }, "id": { "description": "Unique property listing ID", "type": "string" }, "images": { "description": "Property image URLs", "items": { "type": "string" }, "type": "array" }, "link": { "description": "URL to property details page", "type": "string" }, "position": { "description": "Position in search results", "type": "integer" }, "price": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_Price" }, "rating": { "description": "Average rating score", "type": "number" }, "reviews": { "description": "Number of reviews", "type": "integer" }, "time_period": { "description": "Date range display text", "type": "string" }, "title": { "description": "Property title", "type": "string" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchInformation": { "properties": { "adults": { "description": "Number of adult guests", "type": "integer" }, "check_in_date": { "description": "Check-in date from search", "type": "string" }, "check_out_date": { "description": "Check-out date from search", "type": "string" }, "children": { "description": "Number of child guests", "type": "integer" }, "guests": { "description": "Guest count display text", "type": "string" }, "infants": { "description": "Number of infant guests", "type": "integer" }, "pets": { "description": "Number of pets", "type": "integer" }, "query_displayed": { "description": "Location query as displayed by Airbnb", "type": "string" }, "results": { "description": "Results summary text", "type": "string" }, "time_period": { "description": "Time period display text", "type": "string" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchMetadata": { "properties": { "created_at": { "description": "Timestamp when the search was created", "format": "date-time", "type": "string" }, "html_url": { "description": "URL to view HTML results", "type": "string" }, "id": { "description": "Unique identifier for the search request", "type": "string" }, "json_url": { "description": "URL to view JSON results", "type": "string" }, "parsing_time_taken": { "description": "Time taken to parse the results in seconds", "type": "number" }, "request_time_taken": { "description": "Time taken to make the request in seconds", "type": "number" }, "request_url": { "description": "Airbnb URL for this search", "type": "string" }, "status": { "description": "Status of the search request", "type": "string" }, "total_time_taken": { "description": "Total time taken for the search in seconds", "type": "number" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchParameters": { "properties": { "adults": { "description": "Number of adults", "type": "integer" }, "airbnb_domain": { "description": "Airbnb domain searched", "type": "string" }, "amenities": { "description": "Amenities filter", "type": "string" }, "bathrooms": { "description": "Minimum bathrooms", "type": "integer" }, "bedrooms": { "description": "Minimum bedrooms", "type": "integer" }, "beds": { "description": "Minimum beds", "type": "integer" }, "bounding_box": { "description": "Geographic bounding box coordinates", "type": "string" }, "check_in_date": { "description": "Check-in date", "type": "string" }, "check_out_date": { "description": "Check-out date", "type": "string" }, "children": { "description": "Number of children", "type": "integer" }, "currency": { "description": "Currency code for pricing", "type": "string" }, "engine": { "description": "Search engine used", "type": "string" }, "include_taxes": { "description": "Whether tax-inclusive pricing was requested", "type": "string" }, "infants": { "description": "Number of infants", "type": "integer" }, "next_page_token": { "description": "Pagination token", "type": "string" }, "pets": { "description": "Number of pets", "type": "integer" }, "price_max": { "description": "Maximum price filter", "type": "integer" }, "price_min": { "description": "Minimum price filter", "type": "integer" }, "property_types": { "description": "Property types filter", "type": "string" }, "q": { "description": "Search query location", "type": "string" }, "time_period": { "description": "Flexible trip length", "type": "string" }, "type_of_place": { "description": "Type of accommodation", "type": "string" } }, "type": "object" }, "youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchResponse": { "properties": { "error": { "description": "Error message when no results are found", "type": "string" }, "pagination": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_Pagination" }, "properties": { "description": "List of property results", "items": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_Property" }, "type": "array" }, "search_information": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchInformation" }, "search_metadata": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchMetadata" }, "search_parameters": { "$ref": "#/components/schemas/youtube_5e7b3be832ec__ResponseBfde03595B3D_SearchParameters" } }, "type": "object" } } } }