Apple App Store Reviews 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"
          ]
        },
        "country": {
          "description": "Parameter defines the country to use for the search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). Head to the [Apple Regions](https://Asale.com/apple-regions) for a full list of supported Apple Regions.",
          "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 Apple 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 cach",
          "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"
          ]
        },
        "page": {
          "description": "Parameter is used to get the items on a specific page. (e.g., 1 (default) is the first page of results, 2 is the 2nd page of results, 3 is the 3rd page of results, etc.).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "product_id": {
          "description": "Parameter defines the ID of a product you want to get the reviews for. You can find the ID of a product from [App Store API](https://Asale.com/apple-app-store) json results, You can also get it from the URL of the app. For example `product_id` of \"https://apps.apple.com/us/app/the-great-coffee-app/id534220544\", is the long numerical value that comes after \"id\", 534220544 (default).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "sort": {
          "description": "Parameter is used for sorting reviews for the iOS App Store (iPhone and iPad). It can be set to: `mostrecent`: Most recent (default), `mosthelpful`: Most helpful, `mostfavorable`: Most favorable, `mostcritical`: Most critical This parameter has no effect on the macOS App Store. Reviews from the macOS App Store will always be sorted from most recent to least recent.",
          "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": [
        "product_id"
      ],
      "type": "object"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}