Yelp Place Scraper 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"
          ]
        },
        "business_alert": {
          "description": "Set parameter to `true` to include business alert information when available. It defaults to `false`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "full_menu": {
          "description": "Set parameter to `true` to scrape business full menu when available. It defaults to `false`. When the parameter `full_menu` is set to `true`, but the business queried doesn't have a full menu page, then `place_results` will be returned instead of `full_menu_results`. This information will also be returned in `search_information` and `error` keys in the json response.",
          "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"
          ]
        },
        "menu_name": {
          "description": "Parameter defines the name of which Full Menu to scrape when more than one Full Menu is available. It can only be used in combination with `full_menu` parameter.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "no_cache": {
          "description": "Parameter will force SerpApi to fetch the Yelp Place 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"
          ]
        },
        "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 Yelp ID of a place. Each place has two unique IDs (e.g. `ED7A7vDdg8yLNKJTSVHHmg` and `arabica-brooklyn`) and you can use either of them as a value of the `place_id`. To extract the IDs of a place you can use our [Yelp Search API](https://Asale.com/yelp-search-api).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "yelp_domain": {
          "description": "Parameter defines the Yelp domain to use. It defaults to `yelp.com`. Head to the [Yelp domains](yelp-domains) for a full list of supported Yelp domains.",
          "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": [
        "place_id"
      ],
      "type": "object"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}