{
  "openapi": "3.0.1",
  "info": {
    "title": "Apple App Store Scraper",
    "description": "Scrape the Apple App Store into clean datasets — search apps by keyword or URL, or look up by ID for ratings, pricing, category, version, screenshots and customer reviews. Fast overview or full detail mode. Clean JSON/CSV, no code, no account.",
    "version": "1.0",
    "x-build-id": "hhMjwGQWLCyfVjDPu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~apple-app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-apple-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/sian.agency~apple-app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-apple-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/sian.agency~apple-app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-apple-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": {
          "scrapeMode": {
            "title": "🧭 Scrape mode",
            "enum": [
              "overview",
              "detail"
            ],
            "type": "string",
            "description": "🧭 **CHOOSE YOUR DEPTH:**\n- **Overview** — fast App Store search. Each result already carries the full app record (ratings, pricing, category, version, screenshots). Best for category sweeps & ASO keyword research.\n- **Detail** — look up apps by ID for the complete record plus optional **customer reviews**. Best for deep competitor or review analysis.",
            "default": "overview"
          },
          "searchMode": {
            "title": "🎯 Input type",
            "enum": [
              "byKeyword",
              "bySearchUrl",
              "byAppId"
            ],
            "type": "string",
            "description": "🎯 **HOW DO YOU WANT TO FIND APPS?**\n- **By keyword** — type one or more search terms (overview, or detail-via-discovery).\n- **By search URL** — paste an `itunes.apple.com/search?...` URL with your own filters.\n- **By app ID** — paste numeric IDs or App Store URLs (detail mode only).",
            "default": "byKeyword"
          },
          "terms": {
            "title": "🔍 Keywords",
            "type": "array",
            "description": "🔍 **SEARCH KEYWORDS:** one or more App Store search terms (e.g. `meditation`, `habit tracker`, `budget`).\n\n💡 **TIP:** Each keyword runs as its own search. Use the **Bulk edit** button to paste many, one per line.",
            "default": [
              "meditation"
            ],
            "items": {
              "type": "string"
            }
          },
          "searchUrls": {
            "title": "🔗 Search URLs",
            "type": "array",
            "description": "🔗 **PASTE SEARCH URLs:** one or more `itunes.apple.com/search?...` URLs. Any filters in the query string (genre, country, limit, entity) are honored verbatim.\n\n💡 **TIP:** Only used when **Input type = By search URL**.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "appIds": {
            "title": "🆔 App IDs or App Store URLs",
            "type": "array",
            "description": "🆔 **DETAIL LOOKUP:** numeric App Store IDs (e.g. `284882215`) or full `apps.apple.com/...id...` URLs. Each is looked up for the full record (and reviews if enabled).\n\n💡 **TIP:** Only used when **Input type = By app ID** (detail mode).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "🌐 Storefront country",
            "type": "string",
            "description": "🌐 **STOREFRONT:** 2-letter country code (e.g. `US`, `GB`, `DE`, `JP`). Controls language, pricing and which apps appear.",
            "default": "US"
          },
          "maxResults": {
            "title": "🔢 Max apps per run",
            "minimum": 1,
            "type": "integer",
            "description": "🔢 **RUN CAP:** maximum apps to extract.\n\n🎁 **TIER LIMITS:**\n- **FREE users:** up to 25 apps per run\n- **PAID users:** unlimited\n\n💡 Lower this to keep test runs cheap.",
            "default": 100
          },
          "entity": {
            "title": "📱 Platform",
            "enum": [
              "software",
              "iPadSoftware",
              "macSoftware",
              "tvSoftware"
            ],
            "type": "string",
            "description": "📱 **PLATFORM FILTER:** which App Store catalog to search.",
            "default": "software"
          },
          "genreId": {
            "title": "🗂️ Category (genre) ID",
            "type": "string",
            "description": "🗂️ **CATEGORY FILTER (optional):** numeric App Store genre ID to narrow results (e.g. `6013` = Health & Fitness, `6017` = Education).",
            "default": ""
          },
          "lang": {
            "title": "🈯 Result language",
            "type": "string",
            "description": "🈯 **LANGUAGE (optional):** result language code (e.g. `en_us`, `de_de`). Leave blank to use the storefront default.",
            "default": ""
          },
          "includeReviews": {
            "title": "💬 Include customer reviews",
            "type": "boolean",
            "description": "💬 **REVIEWS (detail mode):** also pull customer reviews for each app (rating, title, body, author, version, helpful votes).",
            "default": false
          },
          "reviewPages": {
            "title": "📄 Review pages per app",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "📄 **REVIEW DEPTH:** number of review pages per app (≈50 reviews each, Apple caps at ~10 pages / ~500 reviews).",
            "default": 2
          },
          "reviewSort": {
            "title": "↕️ Review sort",
            "enum": [
              "mostrecent",
              "mosthelpful"
            ],
            "type": "string",
            "description": "↕️ **REVIEW ORDER:** how to sort the reviews that are returned.",
            "default": "mostrecent"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}