{
  "openapi": "3.0.1",
  "info": {
    "title": "Apple App Store Search Scraper",
    "description": "Search the Apple App Store for apps matching a search term. Scrape rich app information app's name, developer, description, price, rating....",
    "version": "0.0",
    "x-build-id": "YpR8wo2KjGAsRlukR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dan.scraper~apple-app-store-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dan.scraper-apple-app-store-search-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/dan.scraper~apple-app-store-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dan.scraper-apple-app-store-search-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/dan.scraper~apple-app-store-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dan.scraper-apple-app-store-search-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "Search Queries",
            "type": "array",
            "description": "List of search queries. The actor will search the Apple App Store for each query and extract the results.",
            "items": {
              "type": "string"
            }
          },
          "maxPagesPerQuery": {
            "title": "Max pages per query",
            "minimum": 1,
            "type": "integer",
            "description": "The maximum number of search result pages crawled for each search query or URL."
          },
          "csvFriendlyOutput": {
            "title": "Output CSV friendly format",
            "type": "boolean",
            "description": "Include shopping results data, use for CSV format"
          },
          "countryCode": {
            "title": "Country",
            "enum": [
              "",
              "al",
              "dz",
              "ao",
              "ai",
              "ag",
              "ar",
              "am",
              "au",
              "at",
              "az",
              "bs",
              "bh",
              "bb",
              "by",
              "be",
              "bz",
              "bj",
              "bm",
              "bt",
              "bo",
              "bw",
              "br",
              "vg",
              "bn",
              "bg",
              "bf",
              "kh",
              "ca",
              "cv",
              "ky",
              "cl",
              "td",
              "cn",
              "co",
              "cd",
              "cr",
              "hr",
              "cy",
              "cz",
              "dk",
              "dm",
              "do",
              "ec",
              "eg",
              "sv",
              "ee",
              "fj",
              "fi",
              "fr",
              "de",
              "gm",
              "gb",
              "gh",
              "gr",
              "gd",
              "gt",
              "gw",
              "gy",
              "hn",
              "hk",
              "hu",
              "is",
              "in",
              "id",
              "ie",
              "il",
              "it",
              "jm",
              "jp",
              "jo",
              "kz",
              "ke",
              "kw",
              "kg",
              "la",
              "lv",
              "lb",
              "li",
              "lt",
              "lu",
              "mo",
              "mk",
              "mg",
              "mw",
              "my",
              "ml",
              "mt",
              "mr",
              "mu",
              "mx",
              "fm",
              "md",
              "mn",
              "ms",
              "mz",
              "na",
              "np",
              "nl",
              "nz",
              "ni",
              "ne",
              "ng",
              "no",
              "om",
              "pk",
              "pw",
              "pa",
              "pg",
              "py",
              "pe",
              "ph",
              "pl",
              "pt",
              "qa",
              "ro",
              "ru",
              "st",
              "sa",
              "sn",
              "sc",
              "sl",
              "sg",
              "sk",
              "si",
              "sb",
              "za",
              "kr",
              "es",
              "lk",
              "kn",
              "lc",
              "vc",
              "sr",
              "sz",
              "se",
              "ch",
              "tw",
              "tj",
              "tz",
              "th",
              "tt",
              "tn",
              "tr",
              "tm",
              "tc",
              "ug",
              "ua",
              "ae",
              "us",
              "uy",
              "uz",
              "ve",
              "vn",
              "ye",
              "zw"
            ],
            "type": "string",
            "description": "This param is for the Country (e.g. <code>es</code> for Spain). The values must be lower-cased <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\" target=\"_blank\">ISO 3166</a> country codes supported by Apple App Store. By default, the actor uses United States (<code>us</code>)."
          },
          "languageCode": {
            "title": "Language",
            "enum": [
              "",
              "pt-br",
              "it-it",
              "hi-in",
              "ca-es",
              "es-es",
              "zh-tw",
              "th-th",
              "da-dk",
              "fi-fi",
              "en-gb",
              "nl-nl",
              "pl-pl",
              "ro-ro",
              "zh-cn",
              "no-no",
              "pt-pt",
              "de-ch",
              "uk-ua",
              "en-us",
              "vi-vi",
              "sv-se",
              "en-ca",
              "fr-fr",
              "sk-sk",
              "zh-hk",
              "hr-hr",
              "en-au",
              "ko-kr",
              "tr-tr",
              "el-gr",
              "ms-my",
              "id-id",
              "cs-cz",
              "hu-hu",
              "fr-ca",
              "es-mx",
              "de-de",
              "ru-ru",
              "ja-jp"
            ],
            "type": "string",
            "description": "Language for the search results. Only set this if you want to use a non-default language for the selected country. Example: </br><code>pt-br</code> For Portugese - Brazil </br><code>it-it</code> For Italian - Italy </br><code>hi-in</code> For Hindi - India </br><code>ca-es</code> For Catalan - Spain </br><code>es-es</code> For Spanish - Spain </br><code>zh-tw</code> For Chinese - Taiwan </br><code>th-th</code> For Thai - Thailand </br><code>da-dk</code> For Danish - Denmark </br><code>fi-fi</code> For Finnish - Finland </br><code>en-gb</code> For English - United Kingdom </br><code>nl-nl</code> For Dutch - Netherlands </br><code>pl-pl</code> For Polish - Poland </br><code>ro-ro</code> For Romanian - Romania </br><code>zh-cn</code> For Chinese - China </br><code>no-no</code> For Norwegian - Norway </br><code>pt-pt</code> For Portugese - Portugal </br><code>de-ch</code> For German - Switzerland </br><code>uk-ua</code> For Ukrainian - Ukraine </br><code>en-us</code> For English - United States </br><code>vi-vi</code> For Vietnamese - Vietnam </br><code>sv-se</code> For Swedish - Sweden </br><code>en-ca</code> For English - Canada </br><code>fr-fr</code> For French - France </br><code>sk-sk</code> For Slovakian - Slovakia </br><code>zh-hk</code> For Chinese - Hong Kong </br><code>hr-hr</code> For Croatian - Croatia </br><code>en-au</code> For English - Australia </br><code>ko-kr</code> For Korean - South Korea </br><code>tr-tr</code> For Turkish - Turkey </br><code>el-gr</code> For Greek - Greece </br><code>ms-my</code> For Malay - Malaysia </br><code>id-id</code> For Indonesian - Indonesia </br><code>cs-cz</code> For Czech - Czechia </br><code>hu-hu</code> For Hungarian - Hungary </br><code>fr-ca</code> For French - Canada </br><code>es-m",
            "default": ""
          },
          "searchDeveloperName": {
            "title": "Searching Developer Name",
            "type": "boolean",
            "description": "Search both app name and  developer name. If you want to search only app name, set this to false."
          },
          "appCategory": {
            "title": "App Category ID",
            "enum": [
              "",
              "6018",
              "6000",
              "6026",
              "6017",
              "6016",
              "6015",
              "6023",
              "6014",
              "7001",
              "7002",
              "7003",
              "7004",
              "7005",
              "7006",
              "7009",
              "7011",
              "7012",
              "7013",
              "7014",
              "7015",
              "7016",
              "7017",
              "7018",
              "7019",
              "6027",
              "6013",
              "6012",
              "6021",
              "6020",
              "6011",
              "6010",
              "6009",
              "6008",
              "6007",
              "6006",
              "6005",
              "6024",
              "6004",
              "6003",
              "6002",
              "6001"
            ],
            "type": "string",
            "description": "App Category ID for the search results. Example: </br><code>6018</code> For Books </br><code>6000</code> For Business</code> </br><code>6026</code> For Developer Tools</code> </br><code>6017</code> For Education</code> </br><code>6016</code> For Entertainment</code> </br><code>6015</code> For Finance</code> </br><code>6023</code> For Food & Drink</code> </br><code>6014</code> For Games</code> </br><code>7001</code> For Games: Action</code> </br><code>7002</code> For Games: Adventure</code> </br><code>7003</code> For Games: Casual</code> </br><code>7004</code> For Games: Board</code> </br><code>7005</code> For Games: Card</code> </br><code>7006</code> For Games: Casino</code> </br><code>7009</code> For Games: Family</code> </br><code>7011</code> For Games: Music</code> </br><code>7012</code> For Games: Puzzle</code> </br><code>7013</code> For Games: Racing</code> </br><code>7014</code> For Games: Role Playing</code> </br><code>7015</code> For Games: Simulation</code> </br><code>7016</code> For Games: Sports</code> </br><code>7017</code> For Games: Strategy</code> </br><code>7018</code> For Games: Trivia</code> </br><code>7019</code> For Games: Word</code> </br><code>6027</code> For Graphics & Design</code> </br><code>6013</code> For Health & Fitness</code> </br><code>6012</code> For Lifestyle</code> </br><code>6021</code> For Magazines & Newspapers</code> </br><code>6020</code> For Medical</code> </br><code>6011</code> For Music</code> </br><code>6010</code> For Navigation</code> </br><code>6009</code> For News</code> </br><code>"
          },
          "device": {
            "title": "Device",
            "enum": [
              "desktop",
              "mobile",
              "tablet"
            ],
            "type": "string",
            "description": "Device can be \"desktop\", \"mobile\" or \"tablet.",
            "default": "desktop"
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}