{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Reviews Scraper – iOS Apps, Search & Top Charts",
    "description": "App Store reviews scraper for the Apple App Store (iOS): user reviews, app details, keyword search results, all apps of a developer and top charts (free, paid, grossing, new, iPad) for any country and genre. Fast HTTP-only, no browser, pay only per result.",
    "version": "1.0",
    "x-build-id": "IA5NsUjuKc1s4Ksba"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/openharvest~app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-openharvest-app-store-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/openharvest~app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-openharvest-app-store-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/openharvest~app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-openharvest-app-store-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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What to scrape",
            "enum": [
              "appDetails",
              "reviews",
              "search",
              "developer",
              "topCharts"
            ],
            "type": "string",
            "description": "<b>App details</b> – full details for App Store IDs, URLs or bundle IDs (optionally with reviews).<br><b>Reviews</b> – user reviews for apps.<br><b>Search</b> – apps matching keywords.<br><b>Developer</b> – all apps of a developer.<br><b>Top charts</b> – top free / paid / grossing / new apps, optionally in one genre.",
            "default": "appDetails"
          },
          "appIds": {
            "title": "App Store IDs, URLs or bundle IDs",
            "type": "array",
            "description": "Used by <b>App details</b> and <b>Reviews</b> modes. Enter numeric App Store IDs (e.g. <code>324684580</code>), App Store URLs like <code>https://apps.apple.com/us/app/spotify-music-and-podcasts/id324684580</code>, or bundle IDs (e.g. <code>com.spotify.client</code>).",
            "default": [
              "324684580"
            ],
            "items": {
              "type": "string"
            }
          },
          "includeReviews": {
            "title": "Also scrape reviews (App details mode)",
            "type": "boolean",
            "description": "In <b>App details</b> mode, also scrape up to <i>Max reviews per app</i> reviews for every app.",
            "default": false
          },
          "includePrivacyLabels": {
            "title": "Also get App Privacy labels (App details mode)",
            "type": "boolean",
            "description": "In <b>App details</b> mode, add a <code>privacy</code> object with the app's App Privacy label: <i>Data Used to Track You</i>, <i>Data Linked to You</i> and <i>Data Not Linked to You</i>, each with data categories, data types and purposes. Charged once per app with the <code>app-extras</code> event (together with version history).",
            "default": false
          },
          "includeVersionHistory": {
            "title": "Also get version history (App details mode)",
            "type": "boolean",
            "description": "In <b>App details</b> mode, add a <code>versionHistory</code> array (<code>version</code>, <code>releaseDate</code>, <code>releaseNotes</code>, newest first; Apple shows up to the last 25 versions). Charged once per app with the <code>app-extras</code> event (together with privacy labels).",
            "default": false
          },
          "searchTerms": {
            "title": "Search keywords",
            "type": "array",
            "description": "Used by <b>Search</b> mode. One keyword per line, e.g. <code>vpn</code>, <code>photo editor</code>. The App Store returns up to ~200 apps per keyword.",
            "items": {
              "type": "string"
            }
          },
          "searchPrice": {
            "title": "Search price filter",
            "enum": [
              "all",
              "free",
              "paid"
            ],
            "type": "string",
            "description": "Used by <b>Search</b> mode. Keep only free or only paid apps.",
            "default": "all"
          },
          "developerIds": {
            "title": "Developers",
            "type": "array",
            "description": "Used by <b>Developer</b> mode. Numeric developer ID (e.g. <code>324684583</code>), developer page URL (e.g. <code>https://apps.apple.com/us/developer/spotify/id324684583</code>) or developer name exactly as shown on the App Store (e.g. <code>Spotify</code>).",
            "items": {
              "type": "string"
            }
          },
          "collection": {
            "title": "Top chart",
            "enum": [
              "TOP_FREE",
              "TOP_PAID",
              "TOP_GROSSING",
              "TOP_FREE_IPAD",
              "TOP_PAID_IPAD",
              "TOP_GROSSING_IPAD",
              "NEW_APPS",
              "NEW_FREE_APPS",
              "NEW_PAID_APPS"
            ],
            "type": "string",
            "description": "Used by <b>Top charts</b> mode. Apple publishes up to 100 apps per chart (new-app charts ~110).",
            "default": "TOP_FREE"
          },
          "category": {
            "title": "Genre",
            "enum": [
              "APPLICATION",
              "GAME",
              "BOOKS",
              "BUSINESS",
              "DEVELOPER_TOOLS",
              "EDUCATION",
              "ENTERTAINMENT",
              "FINANCE",
              "FOOD_AND_DRINK",
              "GRAPHICS_AND_DESIGN",
              "HEALTH_AND_FITNESS",
              "LIFESTYLE",
              "MAGAZINES_AND_NEWSPAPERS",
              "MEDICAL",
              "MUSIC",
              "NAVIGATION",
              "NEWS",
              "PHOTO_AND_VIDEO",
              "PRODUCTIVITY",
              "REFERENCE",
              "SHOPPING",
              "SOCIAL_NETWORKING",
              "SPORTS",
              "TRAVEL",
              "UTILITIES",
              "WEATHER",
              "GAME_ACTION",
              "GAME_ADVENTURE",
              "GAME_BOARD",
              "GAME_CARD",
              "GAME_CASINO",
              "GAME_CASUAL",
              "GAME_EDUCATIONAL",
              "GAME_FAMILY",
              "GAME_MUSIC",
              "GAME_PUZZLE",
              "GAME_RACING",
              "GAME_ROLE_PLAYING",
              "GAME_SIMULATION",
              "GAME_SPORTS",
              "GAME_STRATEGY",
              "GAME_TRIVIA",
              "GAME_WORD"
            ],
            "type": "string",
            "description": "Used by <b>Top charts</b> mode. <code>APPLICATION</code> = all apps, <code>GAME</code> = all games.",
            "default": "APPLICATION"
          },
          "maxItems": {
            "title": "Max apps per keyword / developer / chart",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum number of app results per search keyword, per developer, or for the top chart.",
            "default": 50
          },
          "maxReviews": {
            "title": "Max reviews per app",
            "minimum": 0,
            "maximum": 50000,
            "type": "integer",
            "description": "Maximum number of reviews per app and country (Reviews mode, or App details mode with reviews enabled). There is no fixed Apple cap: popular apps have tens of thousands of written reviews per country (we paged Spotify US back more than 150,000 reviews). Expect roughly 7–29 reviews per second (Apple rate-limits this API; the Actor retries automatically).",
            "default": 100
          },
          "reviewsSort": {
            "title": "Reviews sort order",
            "enum": [
              "newest",
              "mostHelpful",
              "newestAndHelpful"
            ],
            "type": "string",
            "description": "Which reviews to scrape. <b>Newest first</b> is best for monitoring and large exports. <b>Most helpful</b> is Apple's default order on the app page. <b>Newest + most helpful</b> reads the newest list first, then fills up with most helpful reviews not seen yet (de-duplicated).",
            "default": "newest"
          },
          "reviewsRating": {
            "title": "Only reviews with rating",
            "enum": [
              "all",
              "1",
              "2",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Only keep reviews with this star rating. 1-star and 5-star reviews (newest first) come from Apple's own filtered lists, so they are as fast as unfiltered. 2-, 3- and 4-star reviews are filtered from the newest/most helpful lists; at most 15× <i>Max reviews per app</i> reviews are scanned.",
            "default": "all"
          },
          "country": {
            "title": "Country (storefront)",
            "type": "string",
            "description": "Two-letter ISO country code of the App Store to scrape, e.g. <code>us</code>, <code>gb</code>, <code>de</code>, <code>tr</code>, <code>jp</code>. Affects prices, availability, charts and reviews (reviews are per country).",
            "default": "us"
          },
          "language": {
            "title": "Language (optional)",
            "type": "string",
            "description": "Optional language for app texts (title, description, release notes), e.g. <code>en</code>, <code>de</code>, <code>ja</code>, <code>pt-BR</code>. Leave empty to get the storefront's default language. Only works if the developer provides that localization. Privacy labels need a locale the storefront supports, e.g. <code>en-GB</code> for <code>de</code>."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Apple's public endpoints work without a proxy; the reviews API answers many requests with HTTP 429 and the Actor retries them automatically. With Apify Proxy every retry uses a new session (IP), which may help for very large review exports.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}