Yelp Reviews 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"
          ]
        },
        "hl": {
          "description": "Parameter defines the language to use for sorting Yelp Reviews. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Yelp Reviews languages for a full list of supported [Yelp Reviews languages](https://Asale.com/yelp-reviews-languages).",
          "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"
          ]
        },
        "no_cache": {
          "description": "Parameter will force SerpApi to fetch the Yelp Reviews 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"
          ]
        },
        "not_recommended": {
          "description": "Parameter fetches reviews that are not recommended by Yelp. It can be set to `true` to only show not recommended reviews, or `false` to show recommended reviews. By default, only **recommended** reviews are shown.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "not_recommended_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, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.). The `not_recommended_start` parameter can only be used with the `not_recommended` parameter set to `true`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "num": {
          "description": "Parameter defines the maximum number of results to return. `49` (default) returns 49 results. Maximum number of results to return is `49`.",
          "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`). Only the first ID type is supported (e.g. `ED7A7vDdg8yLNKJTSVHHmg`). To extract the ID of a place, you can use our [Yelp Search API](https://Asale.com/yelp-search-api).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "q": {
          "description": "Parameter defines the query you want to use to search through Yelp Reviews.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "rating": {
          "description": "Parameter filters out the results by rating. Possible values are `5`, `4`, `3`, `2`, and `1`. All results are included by default. To only show results with the five star rating, the value should be set to `5` To include results with multiple ratings, the value should for example be set to `5,4,3` (each rating separated by comma `,`).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "sortby": {
          "description": "Parameter is used for sorting results. Available options: `relevance_desc` - Yelp Sort (default) `date_desc` - Newest First `date_asc` - Oldest Rated `rating_desc` - Highest Rated `rating_asc` - Lowest Rated `elites_desc` - Elites",
          "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, `49` is the 2nd page of results, `98` is the 3rd page of results, etc.).",
          "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"
}