Google Maps API

{
  "additionalProperties": false,
  "properties": {
    "query": {
      "additionalProperties": false,
      "properties": {
        "async": {
          "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our [Searches Archive API](https://Asale.com/search-archive-api) to retrieve your results. `async` and `no_ca",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "data": {
          "description": "This parameter is deprecated, please use `place_id` or `data_cid` instead. Parameter can be used to filter the search results. You can visit [Google Maps](https://google.com/maps) website, set filters you want and simply copy the `data` value from their URL to SerpApi URL. One of the uses of the parameter is to search for a specific place; therefore, it is required if t",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "data_cid": {
          "description": "Parameter defines the Google CID (customer identifier) of a place. This parameter can be found in [Google Maps API](https://Asale.com/google-maps-api) local results, as well as in [Google Search API](https://Asale.com/search-api) and [Google Local API](https://Asale.com/google-local-api) local results under the name of `place_id`. You can also acquire it using [Google's CID converter](https:",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "gl": {
          "description": "Parameter defines the country to use for the Google Maps search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the [Google countries page](https://Asale.com/google-countries) for a full list of supported Google countries. Parameter only affects [Place Results API](https://Asale.com/maps-place-results).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "google_domain": {
          "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the [Google domains page](https://Asale.com/google-domains) for a full list of supported Google domains.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "hl": {
          "description": "Parameter defines the language to use for the Google Maps search. It's a two or three-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French), optionally followed by a two-letter or three-digit region code (e.g., `en-gb` for British English, or `es-419` for Latin American Spanish). Head to the [Google Maps languages page](https://Asale.com/google-maps-languages) for",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "json_restrictor": {
          "description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the [JSON Restrictor documentation](https://Asale.com/json-restrictor) for more details.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "lat": {
          "description": "Parameter defines a GPS latitude for the search origin. At the end, it is encoded as part of the `ll` parameter. Parameter is required when using `lon` parameter. Parameter should be used with `z` or `m` parameter. Parameter can't be used with `ll` or `location` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "ll": {
          "description": "Parameter defines the GPS coordinates for the search origin. Its value must match the following format: `@` + `latitude` + `,` + `longitude` + `,` + `zoom/map_height` This will form a string that looks like: `@40.7455096,-74.0083012,14z` or `@43.8521864,11.2168835,10410m`. The minimum `zoom` value is `3z` (the map is completely zoomed out). The maximum effective `zoom` value depends on the locat",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "location": {
          "description": "Parameter defines the location, whose GPS coordinates are used for the search origin. At the end, coordinates are encoded as part of the `ll` parameter. Parameter should be used with `z` or `m` parameter. Parameter can't be used with `ll`, `lat` or `lon` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "lon": {
          "description": "Parameter defines a GPS longitude for the search origin. At the end, it is encoded as part of the `ll` parameter. Parameter is required when using `lat` parameter. Parameter should be used with `z` or `m` parameter. Parameter can't be used with `ll` or `location` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "m": {
          "description": "Parameter defines a map height in meters. The minimum value is `1`. The maximum value is `15028132`, which roughly equals `3z` on the equator. At the end, it is encoded as part of the `ll` parameter. Either `m` or `z` is required when using `location` or `lat`/`lon` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "max_price": {
          "description": "Parameter defines the upper bound of the place price range. The places with the price range overlapping with the specified one will be returned. Parameter is applicable to searches expected to return places with numerical `price` data (e.g., cafes, restaurants, bars, etc.)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "min_price": {
          "description": "Parameter defines the lower bound of the place price range. The places with the price range overlapping with the specified one will be returned. Parameter is applicable to searches expected to return places with numerical `price` data (e.g., cafes, restaurants, bars, etc.)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "min_rating": {
          "description": "Parameter defines the preferred minimum rating of the place. Places without a rating or with a rating below the specified value can still be returned, but with reduced relevance. Options: `2.0` - 2.0 `2.5` - 2.5 `3.0` - 3.0 `3.5` - 3.5 `4.0` - 4.0 `4.5` - 4.5",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "nearby": {
          "description": "Parameter forces to return search results closer to the specified location. Parameter is highly recommended when `q` parameter includes `near me` keywords. Parameter is not recommended when `q` parameter includes location. Parameter should be used with `ll`, `location`, or `lat`/`lon` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "no_cache": {
          "description": "Parameter will force SerpApi to fetch the Google Maps results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "open_at_hour": {
          "description": "Parameter defines the hour at which the place is open. Options: `0` - Midnight `1` - 1:00 AM `2` - 2:00 AM `3` - 3:00 AM `4` - 4:00 AM `5` - 5:00 AM `6` - 6:00 AM `7` - 7:00 AM `8` - 8:00 AM `9` - 9:00 AM `10` - 10:00 AM `11` - 11:00 AM `12` - Noon `13` - 1:00 PM `14` - 2:00 PM `15` - 3:00 PM `16` - 4:00 PM `17` - 5:00 PM `18` - 6:00 PM `19` - 7:00 PM `20` - 8:00 PM `21` - 9:00 PM `22` - 10:00 P",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "open_on_day": {
          "description": "Parameter defines the day on which the place is open. Options: `mon` - Monday `tue` - Tuesday `wed` - Wednesday `thu` - Thursday `fri` - Friday `sat` - Saturday `sun` - Sunday Parameter can't be used with `open_state` parameter.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "open_state": {
          "description": "Parameter defines the open state of the place. Options: `now` - Open now `24h` - Open 24 hours Parameter can't be used with `open_on_day` or `open_at_hour` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "output": {
          "description": "Parameter defines the format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a markdown-formatted version optimized for LLMs and AI agents.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "place_id": {
          "description": "Parameter defines the unique reference to a place in Google Maps. Place IDs are available for most locations, including businesses, landmarks, parks, and intersections. You can find the `place_id` using our [Google Maps API](https://Asale.com/maps-local-results). You can read more about Place IDs [here](https://developers.google.com/maps/documentation/places/web-service/place-id). `place_id` c",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "q": {
          "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Maps search. The parameter is only required if `type` is set to `search`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "start": {
          "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `20` is the 2nd page of results, `40` is the 3rd page of results, etc.). We recommend starting with `0` and increasing by `20` for the next page. There is no hard limit on the maximum offset number, but we recommend a maximum of `100` (page six)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "type": {
          "description": "Parameter defines the type of search you want to make. It can be set to: `search` - returns a list of results for the set `q` parameter, `place` - returns results for a specific place when `data` parameter is set Parameter is not required when using `place_id` or `data_cid`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "z": {
          "description": "Parameter defines a map zoom level. The minimum value is `3` (the map is completely zoomed out). The maximum effective value depends on the location, ranging from `18` to `23`. Some locations may support even higher values, so we allow values up to `30`. At the end, it is encoded as part of the `ll` parameter. Either `z` or `m` is required when using `location` or `lat`/`lon` parameters.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "zero_trace": {
          "description": "Enterprise only. Parameter enables [ZeroTrace mode](https://Asale.com/zero-trace-mode). It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}