{
  "openapi": "3.0.1",
  "info": {
    "title": "Apple App Store Review Scraper & App Ratings Summary",
    "description": "📱 Apple App Store Review Scraper pulls app reviews at scale — ratings, text, titles, dates, versions, locales & user names. 🔍 Filter by country, date or rating. 📊 Export to CSV/JSON. 🚀 Perfect for ASO, sentiment & competitor analysis, UX research, and support triage.",
    "version": "0.1",
    "x-build-id": "kzvx43nQDGTxgXxgY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scraper-engine~apple-app-store-review-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scraper-engine-apple-app-store-review-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/scraper-engine~apple-app-store-review-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scraper-engine-apple-app-store-review-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/scraper-engine~apple-app-store-review-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scraper-engine-apple-app-store-review-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",
        "properties": {
          "appStoreUrls": {
            "title": "🔗 App Store listing links",
            "type": "array",
            "description": "One App Store URL per entry, e.g. `https://apps.apple.com/us/app/spotify-music-and-podcasts/id324684580`. The two-letter country in the URL selects the storefront the reviews come from.",
            "items": {
              "type": "string"
            }
          },
          "reviewsPerApp": {
            "title": "📝 Reviews to collect per app",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Apple's public review feed hard-stops at **500 reviews per app per storefront** (page 11 returns HTTP 400), so 500 is the real ceiling — not a soft limit. Example: 50 → the 50 newest reviews. Default is 20.",
            "default": 20
          },
          "includeRatingHistogram": {
            "title": "⭐ Star histogram + derived average",
            "type": "boolean",
            "description": "Adds the real 1★/2★/3★/4★/5★ rating counts, the average **derived from those counts** (Apple's own field here is rounded to a half star), plus `negativeSharePct`, `positiveSharePct`, the written-review count and the write rate. Default: on.",
            "default": true
          },
          "includeAppDetails": {
            "title": "🏷️ Store listing record",
            "type": "boolean",
            "description": "Adds the app's listing data: name, seller, price + currency, genres, version, release date, release notes, download size, minimum iOS version, age rating, icon URL and Apple's own lifetime/current-version rating averages. Default: on.",
            "default": true
          },
          "includeStoreContext": {
            "title": "📈 Chart rank, privacy labels & similar apps",
            "type": "boolean",
            "description": "Adds a second request to the app's store page for its top-chart rank + category, Apple privacy nutrition-label groups, and up to 10 similar apps with their own ratings. Unranked apps return `null` for rank — never a fake 0. Slower (a large page fetch per app), so it is off by default.",
            "default": false
          },
          "summaryCountry": {
            "title": "🌍 Storefront for the summary",
            "type": "string",
            "description": "Two-letter country code deciding which storefront's rating numbers the summary reports — ratings differ a lot by market. Leave empty to use each app URL's own country. Example: `gb`.",
            "default": ""
          },
          "url": {
            "title": "🔗 url — legacy app link list",
            "type": "array",
            "description": "Original `url` key. Values supplied here are merged ahead of 🔗 App Store listing links.",
            "items": {
              "type": "string"
            }
          },
          "urls": {
            "title": "🔗 urls — legacy secondary list",
            "type": "array",
            "description": "Original undocumented `urls` key, now declared. Merged after `url`.",
            "items": {
              "type": "string"
            }
          },
          "max_review": {
            "title": "🔢 max_review — legacy review cap",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Original `max_review` key; when set it overrides 📝 Reviews to collect per app. Values above 500 are accepted and clamped to 500 (the engine's hard ceiling), and the clamp is logged."
          },
          "max_pages": {
            "title": "📄 max_pages — legacy page cap",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Original `max_pages` key (previously code-only, undeclared). Each page holds up to 50 reviews; 10 pages is Apple's hard maximum."
          },
          "delay_between_pages": {
            "title": "⏱️ delay_between_pages — legacy pacing",
            "minimum": 0,
            "maximum": 60,
            "type": "integer",
            "description": "Original `delay_between_pages` key (previously code-only, undeclared). Seconds to wait between review pages. Default is 1.5."
          },
          "proxyConfiguration": {
            "title": "🌐 Proxy",
            "type": "object",
            "description": "Optional Apify Proxy settings. The Apple feeds used here are public and normally work with no proxy at all; the actor escalates automatically only if a request is refused."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}