{
  "openapi": "3.0.1",
  "info": {
    "title": "Apple App Store Scraper – Reviews, Keyword Ranks & Charts",
    "description": "Apple App Store data from Apple's official public endpoints: app details by URL, ID or bundle ID, customer reviews with new-review monitoring, keyword search rankings (ASO) and top charts in 150+ countries. No login or proxies; pay only for rows you get.",
    "version": "1.0",
    "x-build-id": "7Fu2TzvjvbqVeJqqo"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/pinkish_armada~app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-pinkish_armada-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/pinkish_armada~app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-pinkish_armada-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/pinkish_armada~app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-pinkish_armada-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",
        "properties": {
          "apps": {
            "title": "Apps (URL, ID or bundle ID)",
            "type": "array",
            "description": "App Store links (https://apps.apple.com/us/app/notion/id1232780281), numeric app IDs (1232780281) or bundle IDs (com.spotify.client). Returns one app-details row per app and country.",
            "items": {
              "type": "string"
            }
          },
          "searchTerms": {
            "title": "Search keywords (rank tracking)",
            "type": "array",
            "description": "Keywords to search in the App Store. Each result row includes its rank position for that keyword, which is how you track ASO keyword rankings over time.",
            "items": {
              "type": "string"
            }
          },
          "charts": {
            "title": "Top charts",
            "type": "array",
            "description": "Charts to download (up to 100–200 apps each).",
            "items": {
              "type": "string",
              "enum": [
                "topFree",
                "topPaid",
                "topGrossing",
                "topFreeIpad",
                "topPaidIpad",
                "topGrossingIpad",
                "newApps",
                "newFree",
                "newPaid",
                "topFreeMac"
              ],
              "enumTitles": [
                "Top free (iPhone)",
                "Top paid (iPhone)",
                "Top grossing (iPhone)",
                "Top free (iPad)",
                "Top paid (iPad)",
                "Top grossing (iPad)",
                "New apps",
                "New free apps",
                "New paid apps",
                "Top free (Mac)"
              ]
            }
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "Two-letter App Store country codes (us, gb, au, de, jp...). Every app, keyword and chart is fetched for each country. Default: us.",
            "items": {
              "type": "string"
            }
          },
          "includeAppDetails": {
            "title": "Return app details",
            "type": "boolean",
            "description": "Return one row per app with name, developer, price, rating, rating count, version, release notes, size, genres, description and screenshots. Turn off if you only want reviews.",
            "default": true
          },
          "includeReviews": {
            "title": "Return customer reviews",
            "type": "boolean",
            "description": "Also download written customer reviews for each app (rating, title, text, app version, date, helpfulness votes).",
            "default": false
          },
          "maxReviewsPerApp": {
            "title": "Max reviews per app and country",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Apple's public review feed returns up to 500 reviews per app, country and sort order. Add more countries to get more.",
            "default": 100
          },
          "reviewSort": {
            "title": "Review sort order",
            "enum": [
              "mostRecent",
              "mostHelpful"
            ],
            "type": "string",
            "description": "Most recent (best for monitoring) or most helpful first.",
            "default": "mostRecent"
          },
          "reviewsSince": {
            "title": "Only reviews since",
            "type": "string",
            "description": "Absolute date (2026-09-01) or relative period (24 hours, 7 days, 2 weeks). Leave empty for no date filter."
          },
          "minRating": {
            "title": "Minimum star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only return reviews with at least this many stars (1–5).",
            "default": 1
          },
          "maxRating": {
            "title": "Maximum star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only return reviews with at most this many stars. Set to 2 to get only negative reviews.",
            "default": 5
          },
          "onlyNewReviews": {
            "title": "Monitor: only new reviews",
            "type": "boolean",
            "description": "Remember which reviews were already returned (in a named key-value store) and return only reviews you haven't seen before. Ideal with an Apify Schedule for daily review alerts. The first run returns the current reviews.",
            "default": false
          },
          "stateStoreName": {
            "title": "Monitor state store name",
            "type": "string",
            "description": "Named key-value store used by monitor mode. Use different names for independent monitors.",
            "default": "app-store-scraper-state"
          },
          "anonymizeReviewers": {
            "title": "Remove reviewer names",
            "type": "boolean",
            "description": "Drop reviewer nicknames and profile links from review rows (recommended if you don't need them, e.g. for GDPR data minimisation).",
            "default": false
          },
          "maxSearchResults": {
            "title": "Max results per keyword",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many ranked apps to return per keyword and country (Apple returns at most 200).",
            "default": 50
          },
          "chartLimit": {
            "title": "Apps per chart",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many ranked apps to request per chart (Apple usually returns up to 100).",
            "default": 100
          },
          "chartGenreId": {
            "title": "Chart genre ID (optional)",
            "type": "string",
            "description": "Restrict charts to one App Store category, e.g. 6014 Games, 6017 Education, 6015 Finance, 6013 Health & Fitness, 6007 Productivity, 6016 Entertainment, 6005 Social Networking. Empty = all apps."
          },
          "chartDetails": {
            "title": "Full app details for chart entries",
            "type": "boolean",
            "description": "Add rating, rating count, version, size and other details to every chart entry (no extra charge).",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}