{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Reviews Scraper (Multi-Country)",
    "description": "Scrape Apple App Store reviews for any app across many countries in one run. Deduplicated JSON with rating, app version, sentiment and topic tags, star/date/keyword filters, app metadata and new-reviews-only alerts. Official Apple feeds only.",
    "version": "1.0",
    "x-build-id": "cVQ9F5FhxsRVN2A9K"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cleanfeed-data~app-store-reviews/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cleanfeed-data-app-store-reviews",
        "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/cleanfeed-data~app-store-reviews/runs": {
      "post": {
        "operationId": "runs-sync-cleanfeed-data-app-store-reviews",
        "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/cleanfeed-data~app-store-reviews/run-sync": {
      "post": {
        "operationId": "run-sync-cleanfeed-data-app-store-reviews",
        "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": [
          "apps"
        ],
        "properties": {
          "apps": {
            "title": "Apps",
            "type": "array",
            "description": "One app per line: an App Store URL (https://apps.apple.com/us/app/…/id570060128), a numeric app ID (570060128), a bundle ID (com.spotify.client), or an app name to search for (\"Duolingo\"). Prefixes <code>id:</code>, <code>bundle:</code> and <code>search:</code> force the interpretation.",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Countries (App Store storefronts)",
            "type": "array",
            "description": "Two-letter App Store storefront codes, e.g. <code>us</code>, <code>gb</code>, <code>de</code>, <code>jp</code>, <code>br</code>. Reviews are separate per country. Use <code>major</code> for ~48 large markets or <code>all</code> for ~175 storefronts.",
            "default": [
              "us"
            ],
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "Sort / source",
            "enum": [
              "mostrecent",
              "mosthelpful",
              "both"
            ],
            "type": "string",
            "description": "Which Apple feed to read. Apple exposes up to 500 reviews per storefront per sort order. <b>Both</b> combines the 500 most recent and the 500 most helpful, deduplicated (up to ~1,000 per storefront).",
            "default": "mostrecent"
          },
          "maxReviewsPerAppCountry": {
            "title": "Max reviews per app per country",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Up to 500 per sort order (1,000 with \"Both\"). Lower values fetch fewer pages.",
            "default": 500
          },
          "maxResults": {
            "title": "Max reviews (total)",
            "minimum": 0,
            "type": "integer",
            "description": "Total cap across all apps and countries (0 = unlimited). Prefilled to 100 so your first test run is fast and cheap; set 0 for everything. Split fairly: each app/country gets an equal share and unused share from small ones goes to the others. Also caps your cost ($0.30 per 1,000 reviews).",
            "default": 0
          },
          "minRating": {
            "title": "Min stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Keep reviews with at least this many stars.",
            "default": 1
          },
          "maxRating": {
            "title": "Max stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Keep reviews with at most this many stars (e.g. 2 for complaints only).",
            "default": 5
          },
          "dateFrom": {
            "title": "Reviews from (date)",
            "type": "string",
            "description": "Only reviews on or after this date (YYYY-MM-DD). With \"Most recent\" the Actor stops paging once it passes this date."
          },
          "dateTo": {
            "title": "Reviews until (date)",
            "type": "string",
            "description": "Only reviews on or before this date (YYYY-MM-DD)."
          },
          "reviewedWithinDays": {
            "title": "Reviewed within (days)",
            "minimum": 0,
            "type": "integer",
            "description": "Only reviews from the last N days (0 = off). Combined with \"Reviews from\" the later date wins.",
            "default": 0
          },
          "keywords": {
            "title": "Keywords to tag",
            "type": "array",
            "description": "Case-insensitive words/phrases to look for in the title and text. Matches are listed in <code>matchedKeywords</code>.",
            "items": {
              "type": "string"
            }
          },
          "onlyMatchingKeywords": {
            "title": "Only reviews matching a keyword",
            "type": "boolean",
            "description": "Drop reviews that match none of the keywords above.",
            "default": false
          },
          "enrich": {
            "title": "Add sentiment & topic tags",
            "type": "boolean",
            "description": "Adds <code>sentiment</code> (positive/neutral/negative), <code>sentimentScore</code> (-1..1, star rating blended with a word lexicon) and <code>topics</code> (bug-crash, performance, login-account, ads, pricing-subscription, ui-ux, customer-support, feature-request, update-regression, privacy, notifications, sync-data-loss). Heuristic and English-centric.",
            "default": true
          },
          "includeAppDetails": {
            "title": "Also output app details per country",
            "type": "boolean",
            "description": "Adds one dataset item per app and country (itemType \"app\") with rating average and count, price, version, release notes, genres, developer, screenshots and more. Charged as a separate app-result event.",
            "default": false
          },
          "anonymizeUsers": {
            "title": "Anonymize reviewers",
            "type": "boolean",
            "description": "Remove reviewer nicknames and profile links, and replace the reviewer ID with a one-way hash (still lets you count repeat reviewers). Recommended if you store data about EU/UK users.",
            "default": false
          },
          "onlyNew": {
            "title": "Only new reviews since last run",
            "type": "boolean",
            "description": "Monitoring mode for scheduled runs: output only reviews not returned by a previous run with the same state store. The first run returns everything matching (baseline). Every item has <code>isNew</code> either way.",
            "default": false
          },
          "stateStoreName": {
            "title": "State store name",
            "type": "string",
            "description": "Named key-value store that remembers seen reviews between runs. Use a different name per saved task you monitor separately.",
            "default": "app-store-reviews-state"
          },
          "searchResultsPerTerm": {
            "title": "Apps per name search",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "When an app is given by name, how many top search results to include (1 = best match only).",
            "default": 1
          },
          "maxConcurrency": {
            "title": "Parallel app/country fetches",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "How many app/storefront pairs are processed at once. Requests are still spaced by the delays below.",
            "default": 4
          },
          "requestDelayMs": {
            "title": "Min delay between review-feed requests (ms)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Polite spacing for Apple's review RSS feed.",
            "default": 250
          },
          "searchDelayMs": {
            "title": "Min delay between Search/Lookup API calls (ms)",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Apple documents roughly 20 Search API calls per minute; the default 3000 ms respects that.",
            "default": 3000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}