{
  "openapi": "3.0.1",
  "info": {
    "title": "Apple App Store Scraper — Apps, Reviews & Charts",
    "description": "Scrape the Apple App Store: search apps, full app details, top free/paid/grossing charts, whole developer portfolios and user reviews. Rich metadata (ratings, versions, sizes, screenshots) plus a monitoring mode for new apps and reviews. No login, no key, no browser.",
    "version": "0.1",
    "x-build-id": "WhMEg2fzj1v38SqEe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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": [
              "search",
              "appDetails",
              "topCharts",
              "developerApps",
              "reviews"
            ],
            "type": "string",
            "description": "Pick a job. Search finds apps by keyword. App details pulls the full record for specific apps. Top charts lists the top free/paid/grossing apps in a category. Developer apps returns a developer's whole portfolio. Reviews pulls user reviews for specific apps.",
            "default": "search"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Keywords to search the App Store for, e.g. `habit tracker`, `crypto wallet`. One row per term. (Mode: Search.)",
            "items": {
              "type": "string"
            }
          },
          "appIds": {
            "title": "App IDs / bundle IDs / URLs",
            "type": "array",
            "description": "Numeric App Store IDs (e.g. `324684580`), bundle IDs (e.g. `com.spotify.client`), or full App Store URLs. Used by the App details and Reviews modes.",
            "items": {
              "type": "string"
            }
          },
          "collection": {
            "title": "Chart",
            "enum": [
              "TOP_FREE",
              "TOP_PAID",
              "TOP_GROSSING"
            ],
            "type": "string",
            "description": "Which ranking to pull. (Mode: Top charts.)",
            "default": "TOP_FREE"
          },
          "genre": {
            "title": "Category",
            "enum": [
              "ALL",
              "6014",
              "6000",
              "6015",
              "6007",
              "6005",
              "6008",
              "6002",
              "6012",
              "6013",
              "6017",
              "6016",
              "6003",
              "6011",
              "6018",
              "6023",
              "6024",
              "6020",
              "6010",
              "6009",
              "6004",
              "6006",
              "6001"
            ],
            "type": "string",
            "description": "Category for the top chart, or `All apps` for the overall chart. (Mode: Top charts.)",
            "default": "ALL"
          },
          "developerIds": {
            "title": "Developer (artist) IDs / URLs",
            "type": "array",
            "description": "Numeric developer (artist) IDs, e.g. `324684583`, or App Store developer URLs like `https://apps.apple.com/us/developer/spotify/id324684583`. Returns every app in their portfolio. (Mode: Developer apps.)",
            "items": {
              "type": "string"
            }
          },
          "maxAppsPerQuery": {
            "title": "Max apps per query",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Cap the number of apps returned per search term, chart, or developer (Apple returns up to 200).",
            "default": 50
          },
          "fullDetails": {
            "title": "Enrich chart apps with full details",
            "type": "boolean",
            "description": "For Top charts, open each ranked app for the complete record (full description, ratings, version, size, release notes, screenshots…). Search and Developer modes already return full records. Turn off for a faster, lighter chart listing.",
            "default": true
          },
          "maxReviewsPerApp": {
            "title": "Max reviews per app",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "How many reviews to fetch per app, newest first by default. Apple's public review feed exposes roughly the latest 500 per app (50 per page, 10 pages). (Mode: Reviews.)",
            "default": 100
          },
          "reviewsSort": {
            "title": "Sort reviews by",
            "enum": [
              "mostrecent",
              "mosthelpful"
            ],
            "type": "string",
            "description": "Order in which reviews are pulled. (Mode: Reviews.)",
            "default": "mostrecent"
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Two-letter App Store storefront code (e.g. `us`, `gb`, `de`, `jp`). Affects rankings, pricing, availability and the review pool.",
            "default": "us"
          },
          "language": {
            "title": "Language (optional)",
            "type": "string",
            "description": "Optional Apple language tag for app metadata, e.g. `en_us`, `de_de`, `fr_fr`. Leave blank to use the storefront default.",
            "default": ""
          },
          "monitorMode": {
            "title": "Monitoring mode — only new records",
            "type": "boolean",
            "description": "Remember what was already returned and emit ONLY records not seen in previous runs (new apps for a search/chart, or new reviews for an app). Pairs with Apify Schedules to track changes over time.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'already seen' ids for monitoring mode. Use a different name per tracked target/query to keep their histories separate.",
            "default": "app-store-monitor"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum parallel requests. Lower it if you hit rate limits on very large runs.",
            "default": 6
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Apple's public endpoints have no hard anti-bot, so the default Apify proxy is plenty; switch to residential for very large or high-frequency runs.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}