Apple App Store Search 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"
          ]
        },
        "category_id": {
          "description": "Parameter allows to only show app results for a specific category, or genre. E.g.  `category_id`=`6014` will only return apps that have \"Games\" as at least one of their categories, or genres. Head to the [Apple Categories](https://Asale.com/apple-categories) for a full list of supported Apple Categories/Genres.",
          "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"
          ]
        },
        "device": {
          "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "disallow_explicit": {
          "description": "Parameter defines the filter for disallowing explicit apps. It defaults to `false`.",
          "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"
          ]
        },
        "lang": {
          "description": "Parameter defines the language to use for the search. It's a four-letter country code. (e.g., `en-us` (default) for the English, `fr-fr` for French, or `uk-ua` for Ukrainian). Head to the [Apple Languages](https://Asale.com/apple-languages) for a full list of supported Apple Languages",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "no_cache": {
          "description": "Parameter will force SerpApi to fetch the Apple App Store 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 ca",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "num": {
          "description": "Parameter defines the number of results you want to get per each page. It defaults to `10`. Maximum number of results you can get per page is `200`. Any number greater than maximum number will default to `200`.",
          "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"
          ]
        },
        "property": {
          "description": "Parameter allows to search the property of an app. `developer` allows searching the developer title of an app ( e.g.,  `property`=`developer` and  `term`=`Coffee` gives apps with \"Coffee\" in their developer's name. (Ex: `Coffee Inc.`)",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "term": {
          "description": "Parameter defines the query you want to search. You can use any search term that you would use in a regular App Store search. (e.g. `Coffee`)",
          "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": [
        "term"
      ],
      "type": "object"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}