> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative. > - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key. > - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste. > - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`. > - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt # Place Search > Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. ## Request contract * **Method and path:** GET /apis/v1/brave/local/place\_search * **Availability:** enabled * **Request URL template:** [https://api.aisa.one/apis/v1/brave/local/place\_search](https://api.aisa.one/apis/v1/brave/local/place\_search) * **accept:** header; optional * **api-version:** header; optional * **cache-control:** header; optional * **user-agent:** header; optional * **count:** query; optional * **country:** query; optional * **geoloc:** query; optional * **latitude:** query; optional * **location:** query; optional * **longitude:** query; optional * **q:** query; optional * **radius:** query; optional * **safesearch:** query; optional * **search\_lang:** query; optional * **spellcheck:** query; optional * **ui\_lang:** query; optional * **units:** query; optional * **Runtime facts:** 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc [Complete OpenAPI definition](https://aisa.one/docs/openapi/brave-search.json) Effective request and pricing declaration (including authentication and referenced schemas): ```json theme={null} { "operationId": "any_brave_search_apis_v1_brave_local_place_search", "method": "GET", "path": "/apis/v1/brave/local/place_search", "servers": [ { "url": "https://api.aisa.one" } ], "parameters": [ { "deprecated": false, "description": "The default supported media type is application/json.", "examples": { "0": { "value": "application/json" } }, "in": "header", "name": "accept", "required": false, "schema": { "allOf": [ { "enum": [ "application/json", "*/*" ], "title": "Accept", "type": "string" }, { "default": "application/json" } ], "description": "The default supported media type is application/json.", "examples": [ "application/json" ], "title": "Media type" } }, { "deprecated": false, "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "in": "header", "name": "api-version", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.", "title": "API version" } }, { "deprecated": false, "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "in": "header", "name": "cache-control", "required": false, "schema": { "anyOf": [ { "const": "no-cache", "enum": [ "no-cache" ], "title": "CacheControl", "type": "string" }, { "type": "null" } ], "description": "Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.", "title": "Cache control" } }, { "deprecated": false, "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "examples": { "Android": { "description": "Android", "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36" }, "Windows": { "description": "Windows", "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36" }, "iOS": { "description": "iOS", "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1" }, "macOS": { "description": "macOS", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36" } }, "in": "header", "name": "user-agent", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.", "title": "User agent" } }, { "deprecated": false, "description": "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." } } ], "security": [ { "bearerAuth": [] } ], "x-aisa-status": "enabled", "x-aisa-pricing": { "cost_contract": "fixed_success", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.005, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } } } ``` ## Cost and request rules Published reference price: \$0.005 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar. * **Default request reference estimate (USD):** 0.005 * **Cost contract:** fixed\_success * **Published reference multiplier:** 1.0 * **Settlement evidence source:** request\_snapshot ## OpenAPI ````yaml openapi/brave-search.json GET /apis/v1/brave/local/place_search openapi: 3.1.0 info: description: '' title: Brave Search version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-catalogs: brave-search: description: '' title: Brave Search x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-document: facts_hash: 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc generator_version: '3' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-configured-paths: - /apis/v1/brave/images/search - /apis/v1/brave/llm/context - /apis/v1/brave/local/descriptions - /apis/v1/brave/local/place_search - /apis/v1/brave/local/pois - /apis/v1/brave/news/search - /apis/v1/brave/spellcheck/search - /apis/v1/brave/suggest/search - /apis/v1/brave/videos/search - /apis/v1/brave/web/rich - /apis/v1/brave/web/search x-aisa-document: composer_version: '20' document_hash: sha256:dd3bf51bf816c65187edaf986eabe02a048ea79407f7f5e64e18c08fd29983cf facts_hash: 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc generator_version: '3' protocol_version: '1' response_pending: [] schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: brave-search servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/brave/local/place_search: get: tags: - default summary: Place Search description: >- Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. operationId: 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. This is alternative to the latitude and longitude parameters.

in: query name: location required: false schema: anyOf: - type: string - type: 'null' description: >-

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

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/ResponseB91D37C29Ffe_LocalPlaceSearchApiResponse description: Successful Response default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: schemas: ResponseB91D37C29Ffe_LocalPlaceSearchApiResponse: properties: addresses: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_AddressResult' type: array - type: 'null' description: The list of address results for the given query. title: Addresses cities: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_CityResult' type: array - type: 'null' description: The list of city results for the given query. title: Cities countries: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_CountryResult' type: array - type: 'null' description: The list of country results for the given query. title: Countries location: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_ResultReference' title: Mixed type: array neighborhoods: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_NeighborhoodResult' type: array - type: 'null' description: The list of neighborhood results for the given query. title: Neighborhoods query: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_RegionResult' type: array - type: 'null' description: The list of region results for the given query. title: Regions results: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_Unit' - type: 'null' description: Distance from the user’s 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/ResponseB91D37C29Ffe_LocationResult' title: Pois type: array pois_nearby: default: [] description: POIs located nearby this address. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationResult' title: Pois Nearby type: array postal_address: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_ResultReference: description: The ranking order of results on a search result page. properties: all: default: false description: Whether to put all the results from the type at specific position. title: All type: boolean index: anyOf: - type: integer - type: 'null' description: The 0th based index where the result should be placed. title: Index type: description: The type of the result. title: Type type: string required: - type title: ResultReference type: object ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_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/ResponseB91D37C29Ffe_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 ResponseB91D37C29Ffe_LocationResult: description: A result that is location relevant. properties: action: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Action' - type: 'null' description: An action to be taken. categories: default: [] description: A list of categories. items: type: string title: Categories type: array contact: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Contact' - type: 'null' description: The contact of the business associated with the location. coordinates: anyOf: - maxItems: 2 minItems: 2 prefixItems: - type: number - type: number type: array - type: 'null' description: >- A list of coordinates associated with the location. This is a lat long represented as a floating point. title: Coordinates description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description distance: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Unit' - type: 'null' description: The distance of the location from the client. family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp icon_category: anyOf: - type: string - type: 'null' description: An icon category. title: Icon Category id: anyOf: - type: string - type: 'null' description: >- A temporary id associated with this result, which can be used to retrieve extra information about the location. It remains valid for 8 hours. title: Id is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language opening_hours: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_OpeningHours' - type: 'null' description: >- The opening hours, if it is a business, associated with the location. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched pictures: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_PictureResults' - type: 'null' description: A bunch of pictures associated with the business. postal_address: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_PostalAddress' - type: 'null' description: The postal address associated with the location. price_range: anyOf: - type: string - type: 'null' description: >- A display string used to show the price classification for the business. title: Price Range profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. profiles: anyOf: - items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider type: array - type: 'null' description: Profiles associated with the business. title: Profiles provider_url: description: The complete URL of the provider. title: Provider Url type: string rating: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating - type: 'null' description: The ratings of the business. results: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_LocationWebResult' type: array - type: 'null' description: Web results related to this location. title: Results reviews: anyOf: - $ref: '#/components/schemas/ResponseB91D37C29Ffe_Reviews' - type: 'null' description: Aggregated reviews from various sources relevant to the business. serves_cuisine: anyOf: - items: type: string type: array - type: 'null' description: A list of cuisine categories served. title: Serves Cuisine thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: The thumbnail associated with the location. timezone: anyOf: - type: string - type: 'null' description: IANA timezone identifier. title: Timezone timezone_offset: anyOf: - type: integer - type: 'null' description: The UTC offset of the timezone. title: Timezone Offset title: description: The title of the web page. title: Title type: string type: const: location_result default: location_result description: >- Location result type identifier. The value is always location_result. enum: - location_result title: Type type: string url: description: The URL where the page is served. title: Url type: string zoom_level: default: 7 description: The zoom level on the map. title: Zoom Level type: integer required: - title - url - provider_url title: LocationResult type: object ResponseB91D37C29Ffe_Unit: description: A model representing a unit of measurement. properties: units: description: The name of the unit associated with the quantity. title: Units type: string value: description: The quantity of the unit. title: Value type: number required: - value - units title: Unit type: object ResponseB91D37C29Ffe_PostalAddress: description: A model representing a postal address of a location. properties: addressLocality: anyOf: - type: string - type: 'null' description: The address locality or subregion associated with the location. title: Addresslocality addressRegion: anyOf: - type: string - type: 'null' description: The region associated with the location. This is usually a state. title: Addressregion country: anyOf: - type: string - type: 'null' description: The country associated with the location. title: Country displayAddress: description: The displayed address string. title: Displayaddress type: string postalCode: anyOf: - type: string - type: 'null' description: The postal code associated with the location. title: Postalcode streetAddress: anyOf: - type: string - type: 'null' description: The street address associated with the location. title: Streetaddress type: const: PostalAddress default: PostalAddress description: >- The type identifying a postal address. The value is always PostalAddress. enum: - PostalAddress title: Type type: string required: - displayAddress title: PostalAddress type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail: description: Aggregated details representing a picture thumbnail. properties: alt: anyOf: - type: string - type: 'null' description: The alt text for the thumbnail image. title: Alt bg_color: anyOf: - type: string - type: 'null' description: The background color of the thumbnail. title: Bg Color duplicated: anyOf: - type: boolean - type: 'null' description: Whether the thumbnail is a duplicate. title: Duplicated height: anyOf: - type: integer - type: 'null' description: The height of the thumbnail. title: Height logo: anyOf: - type: boolean - type: 'null' description: Whether the thumbnail is a logo. title: Logo original: anyOf: - type: string - type: 'null' description: The original URL of the image. title: Original src: description: The served URL of the picture thumbnail. title: Src type: string theme: anyOf: - type: string - type: 'null' description: The theme of the thumbnail (e.g., light or dark). title: Theme width: anyOf: - type: integer - type: 'null' description: The width of the thumbnail. title: Width required: - src title: Thumbnail type: object ResponseB91D37C29Ffe_Action: description: A model representing an action to be taken. properties: type: description: The type representing the action. title: Type type: string url: description: A URL representing the action to be taken. title: Url type: string required: - type - url title: Action type: object ResponseB91D37C29Ffe_Contact: description: A model representing contact information for an entity. properties: email: anyOf: - type: string - type: 'null' description: The email address. title: Email telephone: anyOf: - type: string - type: 'null' description: The telephone number. title: Telephone title: Contact type: object ResponseB91D37C29Ffe_OpeningHours: description: Opening hours of a business at a particular location. properties: current_day: anyOf: - items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_DayOpeningHours' type: array - type: 'null' description: The current day opening hours. Can have two sets of opening hours. title: Current Day days: anyOf: - items: items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_DayOpeningHours' type: array type: array - type: 'null' description: The opening hours for the whole week. title: Days title: OpeningHours type: object ResponseB91D37C29Ffe_PictureResults: description: A model representing a list of pictures. properties: results: description: A list of thumbnail results. items: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail title: Results type: array viewMoreUrl: anyOf: - type: string - type: 'null' description: A URL to view more pictures. title: Viewmoreurl required: - viewMoreUrl - results title: PictureResults type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile: description: A profile of an entity. properties: img: anyOf: - type: string - type: 'null' description: The served image URL representing the profile. title: Img long_name: anyOf: - type: string - type: 'null' description: The long name of the profile. title: Long Name name: description: The name of the profile. title: Name type: string url: description: The original URL where the profile is available. title: Url type: string required: - name - url title: Profile type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__DataProvider: description: A model representing the data provider associated with the entity. properties: img: anyOf: - type: string - type: 'null' description: The served URL for the image data. title: Img long_name: anyOf: - type: string - type: 'null' description: The long name for the data provider. title: Long Name name: description: The name of the data provider. This can be a domain. title: Name type: string type: const: external default: external description: >- The type representing the source of data. This is usually external. enum: - external title: Type type: string url: description: The URL where the information is coming from. title: Url type: string required: - name - url title: DataProvider type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating: description: The rating associated with an entity. properties: bestRating: description: Best rating received. exclusiveMinimum: 0 title: Bestrating type: number is_tripadvisor: default: false description: Whether the rating is coming from Tripadvisor. title: Is Tripadvisor type: boolean profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: The profile associated with the rating. ratingValue: description: The current value of the rating. minimum: 0 title: Ratingvalue type: number reviewCount: anyOf: - type: integer - type: 'null' description: The number of reviews associated with the rating. title: Reviewcount required: - ratingValue - bestRating title: Rating type: object ResponseB91D37C29Ffe_LocationWebResult: description: A model representing a web result related to a location. properties: description: anyOf: - type: string - type: 'null' default: '' description: A description for the web page. title: Description family_friendly: default: true description: Whether the web page is family friendly. title: Family Friendly type: boolean fetched_content_timestamp: anyOf: - type: integer - type: 'null' description: The timestamp when the content was fetched. title: Fetched Content Timestamp is_source_both: default: false description: Whether the result is from both local and global sources. title: Is Source Both type: boolean is_source_local: default: false description: Whether the result is from a local source. title: Is Source Local type: boolean language: anyOf: - type: string - type: 'null' description: A language classification for the web page. title: Language meta_url: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl description: Aggregated information about the URL. page_age: anyOf: - type: string - type: 'null' description: The page’s date, based on its published or last modified date. title: Page Age page_fetched: anyOf: - type: string - type: 'null' description: A date representing when the web page was last fetched. title: Page Fetched profile: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. title: description: The title of the web page. title: Title type: string url: description: The URL where the page is served. title: Url type: string required: - title - url - meta_url title: LocationWebResult type: object ResponseB91D37C29Ffe_Reviews: description: The reviews associated with an entity. properties: results: description: A list of trip advisor reviews for the entity. items: $ref: '#/components/schemas/ResponseB91D37C29Ffe_TripadvisorReview' title: Results type: array reviews_in_foreign_language: description: Any reviews available in a foreign language. title: Reviews In Foreign Language type: boolean viewMoreUrl: description: >- A URL to a web page where more information on the result can be seen. title: Viewmoreurl type: string required: - results - viewMoreUrl - reviews_in_foreign_language title: Reviews type: object ResponseB91D37C29Ffe_DayOpeningHours: description: >- A model representing the opening hours for a particular day for a business at a particular location. properties: abbr_name: description: A short string representing the day of the week. title: Abbr Name type: string closes: description: >- A 24 hr clock time string for the closing time of the business on a particular day. title: Closes type: string full_name: description: A full string representing the day of the week. title: Full Name type: string opens: description: >- A 24 hr clock time string for the opening time of the business on a particular day. title: Opens type: string required: - abbr_name - full_name - opens - closes title: DayOpeningHours type: object ResponseB91D37C29Ffe_app__models__products__search__v1__shared__MetaUrl: description: Aggregated information about a URL. properties: favicon: description: The favicon used for the URL. title: Favicon type: string hostname: anyOf: - type: string - type: 'null' description: The lowercased domain name extracted from the URL. title: Hostname netloc: description: The network location part extracted from the URL. title: Netloc type: string path: description: The hierarchical path of the URL useful as a display string. title: Path type: string scheme: description: The protocol scheme extracted from the URL. title: Scheme type: string required: - scheme - netloc - favicon - path title: MetaUrl type: object ResponseB91D37C29Ffe_TripadvisorReview: description: A model representing a Tripadvisor review. properties: author: $ref: '#/components/schemas/ResponseB91D37C29Ffe_Person' description: The author of the review. date: description: The date when the review was published. title: Date type: string description: description: A description seen in the review. title: Description type: string language: description: The language of the review. title: Language type: string rating: $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Rating description: A rating given by the reviewer. review_url: description: A URL link to the page where the review can be found. title: Review Url type: string title: description: The title of the review. title: Title type: string required: - title - description - date - rating - author - review_url - language title: TripadvisorReview type: object ResponseB91D37C29Ffe_Person: description: A model describing a person entity. properties: email: anyOf: - type: string - type: 'null' description: Email address of the person. title: Email name: description: The name of the thing. title: Name type: string thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseB91D37C29Ffe_app__models__products__search__v1__shared__Thumbnail - type: 'null' description: Thumbnail associated with the thing. type: const: person default: person description: >- A type identifying a person. The value is always person. enum: - person title: Type type: string url: anyOf: - type: string - type: 'null' description: A URL for the thing. title: Url required: - name title: Person type: object securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.